From 098e15df3044cf1b04a222c1c33c3e6135ac89f3 Mon Sep 17 00:00:00 2001 From: Jason Del Ponte Date: Tue, 28 May 2019 14:51:27 -0700 Subject: [PATCH] Release v0.9.0 (2019-05-28) (#312) Services --- * Synced the V2 SDK with latest AWS service API definitions. * Fixes #304 * Fixes #295 SDK Breaking changes --- This update includes multiple breaking changes to the SDK. These updates improve the SDK's usability, consistency. Client type name --- The API client type is renamed to `Client` for consistency, and remove stutter between package and client type name. Using Amazon S3 API client as an example, the `s3.S3` type is renamed to `s3.Client`. New API operation response type --- API operations' `Request.Send` method now returns a Response type for the specific operation. The Response type wraps the operation's Output parameter, and includes a method for the response's metadata such as RequestID. The Output type is an anonymous embedded field within the Output type. If your application was passing the Output value around you'll need to extract it directly, or pass the Response type instead. New API operation paginator utility --- This change removes the `Paginate` method from API operation Request types, (e.g. ListObjectsRequest). A new Paginator constructor is added that can be used to page these operations. To update your application to use the new pattern, where `Paginate` was being called, replace this with the Paginator type's constructor. The usage of the returned Paginator type is unchanged. ```go req := svc.ListObjectsRequest(params) p := req.Paginate() ``` Is updated to to use the Paginator constructor instead of Paginate method. ```go req := svc.ListObjectsRequest(params) p := s3.NewListObjectsPaginator(req) ``` Other changes --- * Standardizes API client package name to be based on the API model's `ServiceID`. * Standardizes API client operation input and output type names. * Removes `endpoints` package's service identifier constants. These values were unstable. Each API client package contains an `EndpointsID` constant that can be used for service specific endpoint lookup. * Fix API endpoint lookups to use the API's modeled `EndpointsID` (aka `enpdointPrefix`). Searching for API endpoints in the `endpoints` package should use the API client package's, `EndpointsID`. SDK Enhancements --- * Update CI tests to ensure all codegen changes are accounted for in PR (#183) * Updates the CI tests to ensure that any code generation changes are accounted for in the PR, and that there were no mistaken changes made without also running code generation. This change should also help ensure that code generation order is stable, and there are no ordering issues with the SDK's codegen. * Related aws/aws-sdk-go#1966 * `service/dynamodb/expression`: Fix Builder with KeyCondition example (#306) * Fixes the ExampleBuilder_WithKeyCondition example to include the ExpressionAttributeNames member being set. * Fixes #285 * `aws/defaults`: Fix UserAgent execution environment key (#307) * Fixes the SDK's UserAgent key for the execution environment. * Fixes #276 * `private/model/api`: Improve SDK API reference doc generation (#309) * Improves the SDK's generated documentation for API client, operation, and types. This fixes several bugs in the doc generation causing poor formatting, an difficult to read reference documentation. * Fix #308 * Related aws/aws-sdk-go#2617 --- CHANGELOG.md | 55 + aws/endpoints/defaults.go | 1 + aws/version.go | 2 +- .../cmd/op_crawler/create_service.go | 2 + models/apis/chime/2018-05-01/api-2.json | 19 + models/apis/chime/2018-05-01/docs-2.json | 18 +- .../apis/groundstation/2019-05-23/api-2.json | 2059 +++++++++++++++++ .../apis/groundstation/2019-05-23/docs-2.json | 769 ++++++ .../groundstation/2019-05-23/examples-1.json | 4 + .../2019-05-23/paginators-1.json | 40 + .../apis/pinpoint-email/2018-07-26/api-2.json | 265 ++- .../pinpoint-email/2018-07-26/docs-2.json | 163 +- .../2018-07-26/paginators-1.json | 5 + .../apis/pinpoint-email/2018-07-26/smoke.json | 18 + models/apis/rds/2014-10-31/api-2.json | 6 +- models/apis/rds/2014-10-31/docs-2.json | 288 +-- models/apis/robomaker/2018-06-29/api-2.json | 41 +- models/apis/robomaker/2018-06-29/docs-2.json | 27 +- .../apis/storagegateway/2013-06-30/api-2.json | 33 +- .../storagegateway/2013-06-30/docs-2.json | 14 + models/apis/sts/2011-06-15/docs-2.json | 26 +- models/apis/transcribe/2017-10-26/api-2.json | 3 +- models/apis/waf/2015-08-24/docs-2.json | 20 +- models/endpoints/endpoints.json | 1 + service/chime/api_enums.go | 17 + .../chime/api_op_BatchUpdatePhoneNumber.go | 3 +- .../chime/api_op_CreatePhoneNumberOrder.go | 4 +- .../api_op_SearchAvailablePhoneNumbers.go | 12 + service/chime/api_op_UpdatePhoneNumber.go | 3 +- service/chime/api_types.go | 9 + service/groundstation/api_client.go | 79 + service/groundstation/api_doc.go | 32 + service/groundstation/api_enums.go | 175 ++ service/groundstation/api_errors.go | 24 + service/groundstation/api_op_CancelContact.go | 145 ++ service/groundstation/api_op_CreateConfig.go | 203 ++ .../api_op_CreateDataflowEndpointGroup.go | 181 ++ .../api_op_CreateMissionProfile.go | 254 ++ service/groundstation/api_op_DeleteConfig.go | 177 ++ .../api_op_DeleteDataflowEndpointGroup.go | 145 ++ .../api_op_DeleteMissionProfile.go | 145 ++ .../groundstation/api_op_DescribeContact.go | 253 ++ service/groundstation/api_op_GetConfig.go | 220 ++ .../api_op_GetDataflowEndpointGroup.go | 184 ++ .../groundstation/api_op_GetMinuteUsage.go | 198 ++ .../groundstation/api_op_GetMissionProfile.go | 248 ++ service/groundstation/api_op_GetSatellite.go | 197 ++ service/groundstation/api_op_ListConfigs.go | 208 ++ service/groundstation/api_op_ListContacts.go | 300 +++ .../api_op_ListDataflowEndpointGroups.go | 208 ++ .../api_op_ListGroundStations.go | 208 ++ .../api_op_ListMissionProfiles.go | 208 ++ .../groundstation/api_op_ListSatellites.go | 208 ++ .../api_op_ListTagsForResource.go | 151 ++ .../groundstation/api_op_ReserveContact.go | 221 ++ service/groundstation/api_op_TagResource.go | 151 ++ service/groundstation/api_op_UntagResource.go | 157 ++ service/groundstation/api_op_UpdateConfig.go | 218 ++ .../api_op_UpdateMissionProfile.go | 230 ++ service/groundstation/api_types.go | 1506 ++++++++++++ .../groundstationiface/interface.go | 115 + service/pinpointemail/api_doc.go | 24 +- service/pinpointemail/api_enums.go | 21 + service/pinpointemail/api_integ_test.go | 62 + .../api_op_CreateConfigurationSet.go | 12 +- .../api_op_CreateDeliverabilityTestReport.go | 4 +- .../api_op_CreateEmailIdentity.go | 4 +- .../api_op_GetBlacklistReports.go | 4 +- .../api_op_GetConfigurationSet.go | 16 + .../pinpointemail/api_op_GetDedicatedIps.go | 12 +- ...pi_op_GetDeliverabilityDashboardOptions.go | 99 +- .../api_op_GetDeliverabilityTestReport.go | 16 + .../api_op_GetDomainDeliverabilityCampaign.go | 162 ++ .../api_op_GetDomainStatisticsReport.go | 20 +- .../pinpointemail/api_op_GetEmailIdentity.go | 16 + .../api_op_ListConfigurationSets.go | 8 +- .../api_op_ListDedicatedIpPools.go | 8 +- .../api_op_ListDeliverabilityTestReports.go | 8 +- ...pi_op_ListDomainDeliverabilityCampaigns.go | 286 +++ .../api_op_ListEmailIdentities.go | 8 +- .../api_op_ListTagsForResource.go | 6 +- ...api_op_PutDeliverabilityDashboardOption.go | 56 +- service/pinpointemail/api_op_TagResource.go | 10 +- service/pinpointemail/api_types.go | 283 ++- .../pinpointemailiface/interface.go | 4 + service/rds/api_op_BacktrackDBCluster.go | 13 +- service/rds/api_op_CopyDBClusterSnapshot.go | 4 +- service/rds/api_op_CopyDBSnapshot.go | 4 +- service/rds/api_op_CreateDBCluster.go | 20 +- service/rds/api_op_CreateDBInstance.go | 82 +- .../rds/api_op_CreateDBInstanceReadReplica.go | 46 +- service/rds/api_op_CreateEventSubscription.go | 5 +- service/rds/api_op_CreateGlobalCluster.go | 2 +- service/rds/api_op_DeleteDBCluster.go | 18 +- service/rds/api_op_DeleteDBInstance.go | 37 +- .../rds/api_op_DescribeDBClusterSnapshots.go | 18 +- .../rds/api_op_DescribeDBEngineVersions.go | 18 +- service/rds/api_op_DescribeDBSnapshots.go | 15 +- ...i_op_DescribeOrderableDBInstanceOptions.go | 3 +- .../rds/api_op_DescribeReservedDBInstances.go | 4 +- ...op_DescribeReservedDBInstancesOfferings.go | 4 +- .../api_op_ModifyCurrentDBClusterCapacity.go | 2 +- service/rds/api_op_ModifyDBCluster.go | 37 +- service/rds/api_op_ModifyDBInstance.go | 132 +- service/rds/api_op_ModifyEventSubscription.go | 2 +- service/rds/api_op_ModifyGlobalCluster.go | 3 +- service/rds/api_op_ModifyOptionGroup.go | 5 +- service/rds/api_op_RebootDBInstance.go | 7 +- .../api_op_ResetDBClusterParameterGroup.go | 8 +- service/rds/api_op_ResetDBParameterGroup.go | 7 +- service/rds/api_op_RestoreDBClusterFromS3.go | 20 +- .../api_op_RestoreDBClusterFromSnapshot.go | 16 +- .../api_op_RestoreDBClusterToPointInTime.go | 27 +- .../api_op_RestoreDBInstanceFromDBSnapshot.go | 46 +- service/rds/api_op_RestoreDBInstanceFromS3.go | 62 +- .../api_op_RestoreDBInstanceToPointInTime.go | 57 +- service/rds/api_types.go | 117 +- service/robomaker/api_enums.go | 1 + .../robomaker/api_op_CancelDeploymentJob.go | 139 ++ .../robomaker/api_op_CreateSimulationJob.go | 10 + .../robomaker/api_op_DescribeSimulationJob.go | 10 + service/robomaker/api_types.go | 46 +- service/robomaker/robomakeriface/interface.go | 2 + .../storagegateway/api_op_AssignTapePool.go | 149 ++ .../storagegatewayiface/interface.go | 2 + service/sts/api_doc.go | 18 +- service/sts/api_op_AssumeRole.go | 6 +- service/sts/api_op_AssumeRoleWithSAML.go | 6 +- .../sts/api_op_AssumeRoleWithWebIdentity.go | 6 +- service/sts/api_op_GetFederationToken.go | 6 +- service/transcribe/api_enums.go | 1 + service/waf/api_op_CreateRateBasedRule.go | 7 +- service/waf/api_op_CreateRule.go | 7 +- service/waf/api_op_CreateRuleGroup.go | 7 +- service/waf/api_op_CreateWebACL.go | 8 +- service/waf/api_op_PutLoggingConfiguration.go | 2 + service/waf/api_types.go | 33 +- 137 files changed, 12487 insertions(+), 845 deletions(-) create mode 100644 models/apis/groundstation/2019-05-23/api-2.json create mode 100644 models/apis/groundstation/2019-05-23/docs-2.json create mode 100644 models/apis/groundstation/2019-05-23/examples-1.json create mode 100644 models/apis/groundstation/2019-05-23/paginators-1.json create mode 100644 models/apis/pinpoint-email/2018-07-26/smoke.json create mode 100644 service/groundstation/api_client.go create mode 100644 service/groundstation/api_doc.go create mode 100644 service/groundstation/api_enums.go create mode 100644 service/groundstation/api_errors.go create mode 100644 service/groundstation/api_op_CancelContact.go create mode 100644 service/groundstation/api_op_CreateConfig.go create mode 100644 service/groundstation/api_op_CreateDataflowEndpointGroup.go create mode 100644 service/groundstation/api_op_CreateMissionProfile.go create mode 100644 service/groundstation/api_op_DeleteConfig.go create mode 100644 service/groundstation/api_op_DeleteDataflowEndpointGroup.go create mode 100644 service/groundstation/api_op_DeleteMissionProfile.go create mode 100644 service/groundstation/api_op_DescribeContact.go create mode 100644 service/groundstation/api_op_GetConfig.go create mode 100644 service/groundstation/api_op_GetDataflowEndpointGroup.go create mode 100644 service/groundstation/api_op_GetMinuteUsage.go create mode 100644 service/groundstation/api_op_GetMissionProfile.go create mode 100644 service/groundstation/api_op_GetSatellite.go create mode 100644 service/groundstation/api_op_ListConfigs.go create mode 100644 service/groundstation/api_op_ListContacts.go create mode 100644 service/groundstation/api_op_ListDataflowEndpointGroups.go create mode 100644 service/groundstation/api_op_ListGroundStations.go create mode 100644 service/groundstation/api_op_ListMissionProfiles.go create mode 100644 service/groundstation/api_op_ListSatellites.go create mode 100644 service/groundstation/api_op_ListTagsForResource.go create mode 100644 service/groundstation/api_op_ReserveContact.go create mode 100644 service/groundstation/api_op_TagResource.go create mode 100644 service/groundstation/api_op_UntagResource.go create mode 100644 service/groundstation/api_op_UpdateConfig.go create mode 100644 service/groundstation/api_op_UpdateMissionProfile.go create mode 100644 service/groundstation/api_types.go create mode 100644 service/groundstation/groundstationiface/interface.go create mode 100644 service/pinpointemail/api_integ_test.go create mode 100644 service/pinpointemail/api_op_GetDomainDeliverabilityCampaign.go create mode 100644 service/pinpointemail/api_op_ListDomainDeliverabilityCampaigns.go create mode 100644 service/robomaker/api_op_CancelDeploymentJob.go create mode 100644 service/storagegateway/api_op_AssignTapePool.go diff --git a/CHANGELOG.md b/CHANGELOG.md index 87b2a4aaa1f..36e0eceb1a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,58 @@ +Release v0.9.0 (2019-05-28) +=== + +### Services +* Synced the V2 SDK with latest AWS service API definitions. +* Fixes [#304](https://github.com/aws/aws-sdk-go-v2/issues/304) +* Fixes [#295](https://github.com/aws/aws-sdk-go-v2/issues/295) + +### SDK Breaking changes +This update includes multiple breaking changes to the SDK. These updates improve the SDK's usability, consistency. + +#### Client type name +The API client type is renamed to `Client` for consistency, and remove stutter between package and client type name. Using Amazon S3 API client as an example, the `s3.S3` type is renamed to `s3.Client`. + +#### New API operation response type +API operations' `Request.Send` method now returns a Response type for the specific operation. The Response type wraps the operation's Output parameter, and includes a method for the response's metadata such as RequestID. The Output type is an anonymous embedded field within the Output type. If your application was passing the Output value around you'll need to extract it directly, or pass the Response type instead. + +#### New API operation paginator utility +This change removes the `Paginate` method from API operation Request types, (e.g. ListObjectsRequest). A new Paginator constructor is added that can be used to page these operations. To update your application to use the new pattern, where `Paginate` was being called, replace this with the Paginator type's constructor. The usage of the returned Paginator type is unchanged. + +```go +req := svc.ListObjectsRequest(params) +p := req.Paginate() +``` + +Is updated to to use the Paginator constructor instead of Paginate method. + +```go +req := svc.ListObjectsRequest(params) +p := s3.NewListObjectsPaginator(req) +``` + +#### Other changes + * Standardizes API client package name to be based on the API model's `ServiceID`. + * Standardizes API client operation input and output type names. + * Removes `endpoints` package's service identifier constants. These values were unstable. Each API client package contains an `EndpointsID` constant that can be used for service specific endpoint lookup. + * Fix API endpoint lookups to use the API's modeled `EndpointsID` (aka `enpdointPrefix`). Searching for API endpoints in the `endpoints` package should use the API client package's, `EndpointsID`. + +### SDK Enhancements +* Update CI tests to ensure all codegen changes are accounted for in PR ([#183](https://github.com/aws/aws-sdk-go-v2/issues/183)) + * Updates the CI tests to ensure that any code generation changes are accounted for in the PR, and that there were no mistaken changes made without also running code generation. This change should also help ensure that code generation order is stable, and there are no ordering issues with the SDK's codegen. + * Related [aws/aws-sdk-go#1966](https://github.com/aws/aws-sdk-go/issues/1966) + +### SDK Bugs +* `service/dynamodb/expression`: Fix Builder with KeyCondition example ([#306](https://github.com/aws/aws-sdk-go-v2/issues/306)) + * Fixes the ExampleBuilder_WithKeyCondition example to include the ExpressionAttributeNames member being set. + * Fixes [#285](https://github.com/aws/aws-sdk-go-v2/issues/285) +* `aws/defaults`: Fix UserAgent execution environment key ([#307](https://github.com/aws/aws-sdk-go-v2/issues/307)) + * Fixes the SDK's UserAgent key for the execution environment. + * Fixes [#276](https://github.com/aws/aws-sdk-go-v2/issues/276) +* `private/model/api`: Improve SDK API reference doc generation ([#309](https://github.com/aws/aws-sdk-go-v2/issues/309)) + * Improves the SDK's generated documentation for API client, operation, and types. This fixes several bugs in the doc generation causing poor formatting, an difficult to read reference documentation. + * Fix [#308](https://github.com/aws/aws-sdk-go-v2/issues/308) + * Related [aws/aws-sdk-go#2617](https://github.com/aws/aws-sdk-go/issues/2617) + Release v0.8.0 (2019-04-25) === diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go index 0adc92c8fc5..71aeeae54ba 100644 --- a/aws/endpoints/defaults.go +++ b/aws/endpoints/defaults.go @@ -3865,6 +3865,7 @@ var awsusgovPartition = partition{ "athena": service{ Endpoints: endpoints{ + "us-gov-east-1": endpoint{}, "us-gov-west-1": endpoint{}, }, }, diff --git a/aws/version.go b/aws/version.go index 50c412c136f..4209eec71e5 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "0.8.0" +const SDKVersion = "0.9.0" diff --git a/internal/awstesting/cmd/op_crawler/create_service.go b/internal/awstesting/cmd/op_crawler/create_service.go index f7750d2c968..f1b53e42185 100644 --- a/internal/awstesting/cmd/op_crawler/create_service.go +++ b/internal/awstesting/cmd/op_crawler/create_service.go @@ -80,6 +80,7 @@ import ( "github.com/aws/aws-sdk-go-v2/service/globalaccelerator" "github.com/aws/aws-sdk-go-v2/service/glue" "github.com/aws/aws-sdk-go-v2/service/greengrass" + "github.com/aws/aws-sdk-go-v2/service/groundstation" "github.com/aws/aws-sdk-go-v2/service/guardduty" "github.com/aws/aws-sdk-go-v2/service/health" "github.com/aws/aws-sdk-go-v2/service/iam" @@ -268,6 +269,7 @@ func createServices(cfg aws.Config) []service { {name: "globalaccelerator", value: reflect.ValueOf(globalaccelerator.New(cfg))}, {name: "glue", value: reflect.ValueOf(glue.New(cfg))}, {name: "greengrass", value: reflect.ValueOf(greengrass.New(cfg))}, + {name: "groundstation", value: reflect.ValueOf(groundstation.New(cfg))}, {name: "guardduty", value: reflect.ValueOf(guardduty.New(cfg))}, {name: "health", value: reflect.ValueOf(health.New(cfg))}, {name: "iam", value: reflect.ValueOf(iam.New(cfg))}, diff --git a/models/apis/chime/2018-05-01/api-2.json b/models/apis/chime/2018-05-01/api-2.json index 1e0f0eb4002..b8a6f928025 100644 --- a/models/apis/chime/2018-05-01/api-2.json +++ b/models/apis/chime/2018-05-01/api-2.json @@ -2196,6 +2196,7 @@ "members":{ "PhoneNumberId":{"shape":"String"}, "E164PhoneNumber":{"shape":"E164PhoneNumber"}, + "Type":{"shape":"PhoneNumberType"}, "ProductType":{"shape":"PhoneNumberProductType"}, "Status":{"shape":"PhoneNumberStatus"}, "Capabilities":{"shape":"PhoneNumberCapabilities"}, @@ -2301,6 +2302,13 @@ "DeleteFailed" ] }, + "PhoneNumberType":{ + "type":"string", + "enum":[ + "Local", + "TollFree" + ] + }, "Port":{ "type":"integer", "max":65535, @@ -2504,6 +2512,11 @@ "location":"querystring", "locationName":"state" }, + "TollFreePrefix":{ + "shape":"TollFreePrefix", + "location":"querystring", + "locationName":"toll-free-prefix" + }, "MaxResults":{ "shape":"PhoneNumberMaxResults", "location":"querystring", @@ -2594,6 +2607,12 @@ "error":{"httpStatusCode":429}, "exception":true }, + "TollFreePrefix":{ + "type":"string", + "max":3, + "min":3, + "pattern":"^8(00|33|44|55|66|77|88)$" + }, "UnauthorizedClientException":{ "type":"structure", "members":{ diff --git a/models/apis/chime/2018-05-01/docs-2.json b/models/apis/chime/2018-05-01/docs-2.json index b9ccfd45b27..10f3c398dab 100644 --- a/models/apis/chime/2018-05-01/docs-2.json +++ b/models/apis/chime/2018-05-01/docs-2.json @@ -7,11 +7,11 @@ "BatchDeletePhoneNumber": "

Moves phone numbers into the Deletion queue. Phone numbers must be disassociated from any users or Amazon Chime Voice Connectors before they can be deleted.

Phone numbers remain in the Deletion queue for 7 days before they are deleted permanently.

", "BatchSuspendUser": "

Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Users suspended from a Team account are dissasociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.

Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.

To sign out users without suspending them, use the LogoutUser action.

", "BatchUnsuspendUser": "

Removes the suspension from up to 50 previously suspended users for the specified Amazon Chime EnterpriseLWA account. Only users on EnterpriseLWA accounts can be unsuspended using this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

Previously suspended users who are unsuspended using this action are returned to Registered status. Users who are not previously suspended are ignored.

", - "BatchUpdatePhoneNumber": "

Updates phone number product types. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types.

", + "BatchUpdatePhoneNumber": "

Updates phone number product types. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type.

", "BatchUpdateUser": "

Updates user details within the UpdateUserRequestItem object for up to 20 users for the specified Amazon Chime account. Currently, only LicenseType updates are supported for this action.

", "CreateAccount": "

Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.

", "CreateBot": "

Creates a bot for an Amazon Chime Enterprise account.

", - "CreatePhoneNumberOrder": "

Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types.

", + "CreatePhoneNumberOrder": "

Creates an order for phone numbers to be provisioned. Choose from Amazon Chime Business Calling and Amazon Chime Voice Connector product types. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type.

", "CreateVoiceConnector": "

Creates an Amazon Chime Voice Connector under the administrator's AWS account. Enabling CreateVoiceConnectorRequest$RequireEncryption configures your Amazon Chime Voice Connector to use TLS transport for SIP signaling and Secure RTP (SRTP) for media. Inbound calls use TLS transport, and unencrypted outbound calls are blocked.

", "DeleteAccount": "

Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so.

For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.

Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account from your Disabled accounts list, you must contact AWS Support.

After 90 days, deleted accounts are permanently removed from your Disabled accounts list.

", "DeleteEventsConfiguration": "

Deletes the events configuration that allows a bot to receive outgoing events.

", @@ -56,7 +56,7 @@ "UpdateAccountSettings": "

Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.

", "UpdateBot": "

Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.

", "UpdateGlobalSettings": "

Updates global settings for the administrator's AWS account, such as Amazon Chime Business Calling and Amazon Chime Voice Connector settings.

", - "UpdatePhoneNumber": "

Updates phone number details, such as product type, for the specified phone number ID.

", + "UpdatePhoneNumber": "

Updates phone number details, such as product type, for the specified phone number ID. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type.

", "UpdateUser": "

Updates user details for a specified user ID. Currently, only LicenseType updates are supported for this action.

", "UpdateUserSettings": "

Updates the settings for the specified user, such as phone number settings.

", "UpdateVoiceConnector": "

Updates details for the specified Amazon Chime Voice Connector.

" @@ -931,6 +931,12 @@ "PhoneNumber$Status": "

The phone number status.

" } }, + "PhoneNumberType": { + "base": null, + "refs": { + "PhoneNumber$Type": "

The phone number type.

" + } + }, "Port": { "base": null, "refs": { @@ -1170,6 +1176,12 @@ "refs": { } }, + "TollFreePrefix": { + "base": null, + "refs": { + "SearchAvailablePhoneNumbersRequest$TollFreePrefix": "

The toll-free prefix that you use to filter results.

" + } + }, "UnauthorizedClientException": { "base": "

The client is not currently authorized to make the request.

", "refs": { diff --git a/models/apis/groundstation/2019-05-23/api-2.json b/models/apis/groundstation/2019-05-23/api-2.json new file mode 100644 index 00000000000..04164a4917e --- /dev/null +++ b/models/apis/groundstation/2019-05-23/api-2.json @@ -0,0 +1,2059 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-05-23", + "endpointPrefix": "groundstation", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "AWS Ground Station", + "serviceId": "GroundStation", + "signatureVersion": "v4", + "signingName": "groundstation", + "uid": "groundstation-2019-05-23" + }, + "operations": { + "CancelContact": { + "name": "CancelContact", + "http": { + "method": "DELETE", + "requestUri": "/contact/{contactId}", + "responseCode": 200 + }, + "input": { + "shape": "CancelContactRequest" + }, + "output": { + "shape": "ContactIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "idempotent": true + }, + "CreateConfig": { + "name": "CreateConfig", + "http": { + "method": "POST", + "requestUri": "/config", + "responseCode": 200 + }, + "input": { + "shape": "CreateConfigRequest" + }, + "output": { + "shape": "ConfigIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "CreateDataflowEndpointGroup": { + "name": "CreateDataflowEndpointGroup", + "http": { + "method": "POST", + "requestUri": "/dataflowEndpointGroup", + "responseCode": 200 + }, + "input": { + "shape": "CreateDataflowEndpointGroupRequest" + }, + "output": { + "shape": "DataflowEndpointGroupIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "CreateMissionProfile": { + "name": "CreateMissionProfile", + "http": { + "method": "POST", + "requestUri": "/missionprofile", + "responseCode": 200 + }, + "input": { + "shape": "CreateMissionProfileRequest" + }, + "output": { + "shape": "MissionProfileIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "DeleteConfig": { + "name": "DeleteConfig", + "http": { + "method": "DELETE", + "requestUri": "/config/{configType}/{configId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteConfigRequest" + }, + "output": { + "shape": "ConfigIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "idempotent": true + }, + "DeleteDataflowEndpointGroup": { + "name": "DeleteDataflowEndpointGroup", + "http": { + "method": "DELETE", + "requestUri": "/dataflowEndpointGroup/{dataflowEndpointGroupId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteDataflowEndpointGroupRequest" + }, + "output": { + "shape": "DataflowEndpointGroupIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "idempotent": true + }, + "DeleteMissionProfile": { + "name": "DeleteMissionProfile", + "http": { + "method": "DELETE", + "requestUri": "/missionprofile/{missionProfileId}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteMissionProfileRequest" + }, + "output": { + "shape": "MissionProfileIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "idempotent": true + }, + "DescribeContact": { + "name": "DescribeContact", + "http": { + "method": "GET", + "requestUri": "/contact/{contactId}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeContactRequest" + }, + "output": { + "shape": "DescribeContactResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "GetConfig": { + "name": "GetConfig", + "http": { + "method": "GET", + "requestUri": "/config/{configType}/{configId}", + "responseCode": 200 + }, + "input": { + "shape": "GetConfigRequest" + }, + "output": { + "shape": "GetConfigResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "GetDataflowEndpointGroup": { + "name": "GetDataflowEndpointGroup", + "http": { + "method": "GET", + "requestUri": "/dataflowEndpointGroup/{dataflowEndpointGroupId}", + "responseCode": 200 + }, + "input": { + "shape": "GetDataflowEndpointGroupRequest" + }, + "output": { + "shape": "GetDataflowEndpointGroupResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "GetMissionProfile": { + "name": "GetMissionProfile", + "http": { + "method": "GET", + "requestUri": "/missionprofile/{missionProfileId}", + "responseCode": 200 + }, + "input": { + "shape": "GetMissionProfileRequest" + }, + "output": { + "shape": "GetMissionProfileResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "ListConfigs": { + "name": "ListConfigs", + "http": { + "method": "GET", + "requestUri": "/config", + "responseCode": 200 + }, + "input": { + "shape": "ListConfigsRequest" + }, + "output": { + "shape": "ListConfigsResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "ListContacts": { + "name": "ListContacts", + "http": { + "method": "POST", + "requestUri": "/contacts", + "responseCode": 200 + }, + "input": { + "shape": "ListContactsRequest" + }, + "output": { + "shape": "ListContactsResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "ListDataflowEndpointGroups": { + "name": "ListDataflowEndpointGroups", + "http": { + "method": "GET", + "requestUri": "/dataflowEndpointGroup", + "responseCode": 200 + }, + "input": { + "shape": "ListDataflowEndpointGroupsRequest" + }, + "output": { + "shape": "ListDataflowEndpointGroupsResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "ListMissionProfiles": { + "name": "ListMissionProfiles", + "http": { + "method": "GET", + "requestUri": "/missionprofile", + "responseCode": 200 + }, + "input": { + "shape": "ListMissionProfilesRequest" + }, + "output": { + "shape": "ListMissionProfilesResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "ReserveContact": { + "name": "ReserveContact", + "http": { + "method": "POST", + "requestUri": "/contact", + "responseCode": 200 + }, + "input": { + "shape": "ReserveContactRequest" + }, + "output": { + "shape": "ContactIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "UpdateConfig": { + "name": "UpdateConfig", + "http": { + "method": "PUT", + "requestUri": "/config/{configType}/{configId}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateConfigRequest" + }, + "output": { + "shape": "ConfigIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "idempotent": true + }, + "UpdateMissionProfile": { + "name": "UpdateMissionProfile", + "http": { + "method": "PUT", + "requestUri": "/missionprofile/{missionProfileId}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateMissionProfileRequest" + }, + "output": { + "shape": "MissionProfileIdResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "idempotent": true + }, + "GetMinuteUsage": { + "name": "GetMinuteUsage", + "http": { + "method": "POST", + "requestUri": "/minute-usage", + "responseCode": 200 + }, + "input": { + "shape": "GetMinuteUsageRequest" + }, + "output": { + "shape": "GetMinuteUsageResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "GetSatellite": { + "name": "GetSatellite", + "http": { + "method": "GET", + "requestUri": "/satellite/{satelliteId}", + "responseCode": 200 + }, + "input": { + "shape": "GetSatelliteRequest" + }, + "output": { + "shape": "GetSatelliteResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "ListGroundStations": { + "name": "ListGroundStations", + "http": { + "method": "GET", + "requestUri": "/groundstation", + "responseCode": 200 + }, + "input": { + "shape": "ListGroundStationsRequest" + }, + "output": { + "shape": "ListGroundStationsResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "ListSatellites": { + "name": "ListSatellites", + "http": { + "method": "GET", + "requestUri": "/satellite", + "responseCode": 200 + }, + "input": { + "shape": "ListSatellitesRequest" + }, + "output": { + "shape": "ListSatellitesResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "ListTagsForResource": { + "name": "ListTagsForResource", + "http": { + "method": "GET", + "requestUri": "/tags/{resourceArn}", + "responseCode": 200 + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "output": { + "shape": "ListTagsForResourceResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "TagResource": { + "name": "TagResource", + "http": { + "method": "POST", + "requestUri": "/tags/{resourceArn}", + "responseCode": 200 + }, + "input": { + "shape": "TagResourceRequest" + }, + "output": { + "shape": "TagResourceResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ] + }, + "UntagResource": { + "name": "UntagResource", + "http": { + "method": "DELETE", + "requestUri": "/tags/{resourceArn}", + "responseCode": 200 + }, + "input": { + "shape": "UntagResourceRequest" + }, + "output": { + "shape": "UntagResourceResponse" + }, + "errors": [ + { + "shape": "DependencyException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "idempotent": true + } + }, + "shapes": { + "UpdateConfigRequest": { + "type": "structure", + "required": [ + "configData", + "configId", + "configType", + "name" + ], + "members": { + "configData": { + "shape": "ConfigTypeData" + }, + "configId": { + "shape": "String", + "location": "uri", + "locationName": "configId" + }, + "configType": { + "shape": "ConfigCapabilityType", + "location": "uri", + "locationName": "configType" + }, + "name": { + "shape": "SafeName" + } + } + }, + "ConfigTypeData": { + "type": "structure", + "members": { + "antennaDownlinkConfig": { + "shape": "AntennaDownlinkConfig" + }, + "antennaDownlinkDemodDecodeConfig": { + "shape": "AntennaDownlinkDemodDecodeConfig" + }, + "antennaUplinkConfig": { + "shape": "AntennaUplinkConfig" + }, + "dataflowEndpointConfig": { + "shape": "DataflowEndpointConfig" + }, + "trackingConfig": { + "shape": "TrackingConfig" + }, + "uplinkEchoConfig": { + "shape": "UplinkEchoConfig" + } + } + }, + "noradSatelliteID": { + "type": "integer", + "min": 1, + "max": 99999 + }, + "GroundStationData": { + "type": "structure", + "members": { + "groundStationId": { + "shape": "String" + }, + "groundStationName": { + "shape": "String" + }, + "region": { + "shape": "String" + } + } + }, + "GetConfigRequest": { + "type": "structure", + "required": [ + "configId", + "configType" + ], + "members": { + "configId": { + "shape": "String", + "location": "uri", + "locationName": "configId" + }, + "configType": { + "shape": "ConfigCapabilityType", + "location": "uri", + "locationName": "configType" + } + } + }, + "GroundStationList": { + "type": "list", + "member": { + "shape": "GroundStationData" + } + }, + "SecurityGroupIdList": { + "type": "list", + "member": { + "shape": "String" + } + }, + "EndpointDetails": { + "type": "structure", + "members": { + "endpoint": { + "shape": "DataflowEndpoint" + }, + "securityDetails": { + "shape": "SecurityDetails" + } + } + }, + "DataflowEndpointGroupArn": { + "type": "string" + }, + "GetMinuteUsageResponse": { + "type": "structure", + "members": { + "estimatedMinutesRemaining": { + "shape": "Integer" + }, + "isReservedMinutesCustomer": { + "shape": "Boolean" + }, + "totalReservedMinuteAllocation": { + "shape": "Integer" + }, + "totalScheduledMinutes": { + "shape": "Integer" + }, + "upcomingMinutesScheduled": { + "shape": "Integer" + } + } + }, + "MissionProfileListItem": { + "type": "structure", + "members": { + "missionProfileArn": { + "shape": "MissionProfileArn" + }, + "missionProfileId": { + "shape": "String" + }, + "name": { + "shape": "String" + }, + "region": { + "shape": "String" + } + } + }, + "SatelliteList": { + "type": "list", + "member": { + "shape": "SatelliteListItem" + } + }, + "ListDataflowEndpointGroupsResponse": { + "type": "structure", + "members": { + "dataflowEndpointGroupList": { + "shape": "DataflowEndpointGroupList" + }, + "nextToken": { + "shape": "String" + } + } + }, + "AntennaDownlinkDemodDecodeConfig": { + "type": "structure", + "required": [ + "decodeConfig", + "demodulationConfig", + "spectrumConfig" + ], + "members": { + "decodeConfig": { + "shape": "DecodeConfig" + }, + "demodulationConfig": { + "shape": "DemodulationConfig" + }, + "spectrumConfig": { + "shape": "SpectrumConfig" + } + } + }, + "MissionProfileIdResponse": { + "type": "structure", + "members": { + "missionProfileId": { + "shape": "String" + } + } + }, + "SubnetList": { + "type": "list", + "member": { + "shape": "String" + } + }, + "Polarization": { + "type": "string", + "enum": [ + "LEFT_HAND", + "NONE", + "RIGHT_HAND" + ] + }, + "ConfigList": { + "type": "list", + "member": { + "shape": "ConfigListItem" + } + }, + "AntennaUplinkConfig": { + "type": "structure", + "required": [ + "spectrumConfig", + "targetEirp" + ], + "members": { + "spectrumConfig": { + "shape": "UplinkSpectrumConfig" + }, + "targetEirp": { + "shape": "Eirp" + } + } + }, + "Integer": { + "type": "integer", + "box": true + }, + "AntennaDownlinkConfig": { + "type": "structure", + "required": [ + "spectrumConfig" + ], + "members": { + "spectrumConfig": { + "shape": "SpectrumConfig" + } + } + }, + "Boolean": { + "type": "boolean", + "box": true + }, + "EndpointStatus": { + "type": "string", + "enum": [ + "created", + "creating", + "deleted", + "deleting", + "failed" + ] + }, + "UplinkEchoConfig": { + "type": "structure", + "required": [ + "antennaUplinkConfigArn", + "enabled" + ], + "members": { + "antennaUplinkConfigArn": { + "shape": "ConfigArn" + }, + "enabled": { + "shape": "Boolean" + } + } + }, + "DecodeConfig": { + "type": "structure", + "required": [ + "unvalidatedJSON" + ], + "members": { + "unvalidatedJSON": { + "shape": "JsonString" + } + } + }, + "DeleteDataflowEndpointGroupRequest": { + "type": "structure", + "required": [ + "dataflowEndpointGroupId" + ], + "members": { + "dataflowEndpointGroupId": { + "shape": "String", + "location": "uri", + "locationName": "dataflowEndpointGroupId" + } + } + }, + "ContactStatus": { + "type": "string", + "enum": [ + "AVAILABLE", + "AWS_CANCELLED", + "CANCELLED", + "COMPLETED", + "FAILED", + "FAILED_TO_SCHEDULE", + "PASS", + "POSTPASS", + "PREPASS", + "SCHEDULED", + "SCHEDULING" + ] + }, + "MissionProfileList": { + "type": "list", + "member": { + "shape": "MissionProfileListItem" + } + }, + "CreateConfigRequest": { + "type": "structure", + "required": [ + "configData", + "name" + ], + "members": { + "configData": { + "shape": "ConfigTypeData" + }, + "name": { + "shape": "SafeName" + }, + "tags": { + "shape": "TagsMap" + } + } + }, + "Frequency": { + "type": "structure", + "required": [ + "units", + "value" + ], + "members": { + "units": { + "shape": "FrequencyUnits" + }, + "value": { + "shape": "Double" + } + } + }, + "UntagResourceResponse": { + "type": "structure", + "members": { } + }, + "ConfigIdResponse": { + "type": "structure", + "members": { + "configArn": { + "shape": "ConfigArn" + }, + "configId": { + "shape": "String" + }, + "configType": { + "shape": "ConfigCapabilityType" + } + } + }, + "SecurityDetails": { + "type": "structure", + "required": [ + "roleArn", + "securityGroupIds", + "subnetIds" + ], + "members": { + "roleArn": { + "shape": "RoleArn" + }, + "securityGroupIds": { + "shape": "SecurityGroupIdList" + }, + "subnetIds": { + "shape": "SubnetList" + } + } + }, + "TrackingConfig": { + "type": "structure", + "required": [ + "autotrack" + ], + "members": { + "autotrack": { + "shape": "Criticality" + } + } + }, + "CreateDataflowEndpointGroupRequest": { + "type": "structure", + "required": [ + "endpointDetails" + ], + "members": { + "endpointDetails": { + "shape": "EndpointDetailsList" + }, + "tags": { + "shape": "TagsMap" + } + } + }, + "Elevation": { + "type": "structure", + "required": [ + "unit", + "value" + ], + "members": { + "unit": { + "shape": "AngleUnits" + }, + "value": { + "shape": "Double" + } + } + }, + "JsonString": { + "type": "string", + "min": 2, + "max": 8192 + }, + "GetSatelliteRequest": { + "type": "structure", + "required": [ + "satelliteId" + ], + "members": { + "satelliteId": { + "shape": "String", + "location": "uri", + "locationName": "satelliteId" + } + } + }, + "CancelContactRequest": { + "type": "structure", + "required": [ + "contactId" + ], + "members": { + "contactId": { + "shape": "String", + "location": "uri", + "locationName": "contactId" + } + } + }, + "UplinkSpectrumConfig": { + "type": "structure", + "required": [ + "centerFrequency" + ], + "members": { + "centerFrequency": { + "shape": "Frequency" + }, + "polarization": { + "shape": "Polarization" + } + } + }, + "UntagResourceRequest": { + "type": "structure", + "required": [ + "resourceArn", + "tagKeys" + ], + "members": { + "resourceArn": { + "shape": "String", + "location": "uri", + "locationName": "resourceArn" + }, + "tagKeys": { + "shape": "TagKeys", + "location": "querystring", + "locationName": "tagKeys" + } + } + }, + "satelliteArn": { + "type": "string" + }, + "GetMissionProfileResponse": { + "type": "structure", + "members": { + "contactPostPassDurationSeconds": { + "shape": "DurationInSeconds" + }, + "contactPrePassDurationSeconds": { + "shape": "DurationInSeconds" + }, + "dataflowEdges": { + "shape": "DataflowEdgeList" + }, + "minimumViableContactDurationSeconds": { + "shape": "DurationInSeconds" + }, + "missionProfileArn": { + "shape": "MissionProfileArn" + }, + "missionProfileId": { + "shape": "String" + }, + "name": { + "shape": "String" + }, + "region": { + "shape": "String" + }, + "tags": { + "shape": "TagsMap" + }, + "trackingConfigArn": { + "shape": "ConfigArn" + } + } + }, + "ContactIdResponse": { + "type": "structure", + "members": { + "contactId": { + "shape": "String" + } + } + }, + "EndpointDetailsList": { + "type": "list", + "member": { + "shape": "EndpointDetails" + } + }, + "ListGroundStationsRequest": { + "type": "structure", + "members": { + "maxResults": { + "shape": "Integer", + "location": "querystring", + "locationName": "maxResults" + }, + "nextToken": { + "shape": "String", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "InvalidParameterException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + }, + "parameterName": { + "shape": "String" + } + }, + "exception": true, + "error": { + "code": "InvalidParameterException", + "httpStatusCode": 431, + "senderFault": true + } + }, + "DependencyException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + }, + "parameterName": { + "shape": "String" + } + }, + "exception": true, + "error": { + "code": "DependencyException", + "httpStatusCode": 531, + "fault": true + } + }, + "DescribeContactRequest": { + "type": "structure", + "required": [ + "contactId" + ], + "members": { + "contactId": { + "shape": "String", + "location": "uri", + "locationName": "contactId" + } + } + }, + "ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "shape": "String" + } + }, + "exception": true, + "error": { + "code": "ResourceNotFoundException", + "httpStatusCode": 434, + "senderFault": true + } + }, + "Timestamp": { + "type": "timestamp" + }, + "DeleteConfigRequest": { + "type": "structure", + "required": [ + "configId", + "configType" + ], + "members": { + "configId": { + "shape": "String", + "location": "uri", + "locationName": "configId" + }, + "configType": { + "shape": "ConfigCapabilityType", + "location": "uri", + "locationName": "configType" + } + } + }, + "BandwidthUnits": { + "type": "string", + "enum": [ + "GHz", + "MHz", + "kHz" + ] + }, + "SpectrumConfig": { + "type": "structure", + "required": [ + "bandwidth", + "centerFrequency" + ], + "members": { + "bandwidth": { + "shape": "FrequencyBandwidth" + }, + "centerFrequency": { + "shape": "Frequency" + }, + "polarization": { + "shape": "Polarization" + } + } + }, + "DemodulationConfig": { + "type": "structure", + "required": [ + "unvalidatedJSON" + ], + "members": { + "unvalidatedJSON": { + "shape": "JsonString" + } + } + }, + "ListMissionProfilesResponse": { + "type": "structure", + "members": { + "missionProfileList": { + "shape": "MissionProfileList" + }, + "nextToken": { + "shape": "String" + } + } + }, + "ListConfigsResponse": { + "type": "structure", + "members": { + "configList": { + "shape": "ConfigList" + }, + "nextToken": { + "shape": "String" + } + } + }, + "DataflowEdge": { + "type": "list", + "member": { + "shape": "ConfigArn" + }, + "min": 2, + "max": 2 + }, + "SafeName": { + "type": "string", + "min": 1, + "max": 256, + "pattern": "^[ a-zA-Z0-9_:-]+$" + }, + "Eirp": { + "type": "structure", + "required": [ + "units", + "value" + ], + "members": { + "units": { + "shape": "EirpUnits" + }, + "value": { + "shape": "Double" + } + } + }, + "RoleArn": { + "type": "string" + }, + "ListMissionProfilesRequest": { + "type": "structure", + "members": { + "maxResults": { + "shape": "Integer", + "location": "querystring", + "locationName": "maxResults" + }, + "nextToken": { + "shape": "String", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "GetSatelliteResponse": { + "type": "structure", + "members": { + "dateCreated": { + "shape": "Timestamp" + }, + "lastUpdated": { + "shape": "Timestamp" + }, + "noradSatelliteID": { + "shape": "noradSatelliteID" + }, + "satelliteArn": { + "shape": "satelliteArn" + }, + "satelliteId": { + "shape": "Uuid" + }, + "tags": { + "shape": "TagsMap" + } + } + }, + "StatusList": { + "type": "list", + "member": { + "shape": "ContactStatus" + } + }, + "ListContactsRequest": { + "type": "structure", + "required": [ + "endTime", + "startTime", + "statusList" + ], + "members": { + "endTime": { + "shape": "Timestamp" + }, + "groundStation": { + "shape": "String" + }, + "maxResults": { + "shape": "Integer" + }, + "missionProfileArn": { + "shape": "MissionProfileArn" + }, + "nextToken": { + "shape": "String" + }, + "satelliteArn": { + "shape": "satelliteArn" + }, + "startTime": { + "shape": "Timestamp" + }, + "statusList": { + "shape": "StatusList" + } + } + }, + "ContactData": { + "type": "structure", + "members": { + "contactId": { + "shape": "String" + }, + "contactStatus": { + "shape": "ContactStatus" + }, + "endTime": { + "shape": "Timestamp" + }, + "errorMessage": { + "shape": "String" + }, + "groundStation": { + "shape": "String" + }, + "maximumElevation": { + "shape": "Elevation" + }, + "missionProfileArn": { + "shape": "MissionProfileArn" + }, + "postPassEndTime": { + "shape": "Timestamp" + }, + "prePassStartTime": { + "shape": "Timestamp" + }, + "satelliteArn": { + "shape": "satelliteArn" + }, + "startTime": { + "shape": "Timestamp" + }, + "tags": { + "shape": "TagsMap" + } + } + }, + "ListGroundStationsResponse": { + "type": "structure", + "members": { + "groundStationList": { + "shape": "GroundStationList" + }, + "nextToken": { + "shape": "String" + } + } + }, + "DataflowEndpoint": { + "type": "structure", + "members": { + "address": { + "shape": "SocketAddress" + }, + "name": { + "shape": "SafeName" + }, + "status": { + "shape": "EndpointStatus" + } + } + }, + "ListConfigsRequest": { + "type": "structure", + "members": { + "maxResults": { + "shape": "Integer", + "location": "querystring", + "locationName": "maxResults" + }, + "nextToken": { + "shape": "String", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "SocketAddress": { + "type": "structure", + "required": [ + "name", + "port" + ], + "members": { + "name": { + "shape": "String" + }, + "port": { + "shape": "Integer" + } + } + }, + "GetConfigResponse": { + "type": "structure", + "required": [ + "configArn", + "configData", + "configId", + "name" + ], + "members": { + "configArn": { + "shape": "ConfigArn" + }, + "configData": { + "shape": "ConfigTypeData" + }, + "configId": { + "shape": "String" + }, + "configType": { + "shape": "ConfigCapabilityType" + }, + "name": { + "shape": "String" + }, + "tags": { + "shape": "TagsMap" + } + } + }, + "TagsMap": { + "type": "map", + "key": { + "shape": "String" + }, + "value": { + "shape": "String" + } + }, + "TagResourceResponse": { + "type": "structure", + "members": { } + }, + "DeleteMissionProfileRequest": { + "type": "structure", + "required": [ + "missionProfileId" + ], + "members": { + "missionProfileId": { + "shape": "String", + "location": "uri", + "locationName": "missionProfileId" + } + } + }, + "DataflowEndpointGroupList": { + "type": "list", + "member": { + "shape": "DataflowEndpointListItem" + } + }, + "ContactList": { + "type": "list", + "member": { + "shape": "ContactData" + } + }, + "DurationInSeconds": { + "type": "integer", + "min": 1, + "max": 21600 + }, + "SatelliteListItem": { + "type": "structure", + "members": { + "noradSatelliteID": { + "shape": "noradSatelliteID" + }, + "satelliteArn": { + "shape": "satelliteArn" + }, + "satelliteId": { + "shape": "Uuid" + } + } + }, + "GetMissionProfileRequest": { + "type": "structure", + "required": [ + "missionProfileId" + ], + "members": { + "missionProfileId": { + "shape": "String", + "location": "uri", + "locationName": "missionProfileId" + } + } + }, + "Double": { + "type": "double", + "box": true + }, + "ListSatellitesResponse": { + "type": "structure", + "members": { + "nextToken": { + "shape": "String" + }, + "satellites": { + "shape": "SatelliteList" + } + } + }, + "CreateMissionProfileRequest": { + "type": "structure", + "required": [ + "dataflowEdges", + "minimumViableContactDurationSeconds", + "name", + "trackingConfigArn" + ], + "members": { + "contactPostPassDurationSeconds": { + "shape": "DurationInSeconds" + }, + "contactPrePassDurationSeconds": { + "shape": "DurationInSeconds" + }, + "dataflowEdges": { + "shape": "DataflowEdgeList" + }, + "minimumViableContactDurationSeconds": { + "shape": "DurationInSeconds" + }, + "name": { + "shape": "SafeName" + }, + "tags": { + "shape": "TagsMap" + }, + "trackingConfigArn": { + "shape": "ConfigArn" + } + } + }, + "ReserveContactRequest": { + "type": "structure", + "required": [ + "endTime", + "groundStation", + "missionProfileArn", + "satelliteArn", + "startTime" + ], + "members": { + "endTime": { + "shape": "Timestamp" + }, + "groundStation": { + "shape": "String" + }, + "missionProfileArn": { + "shape": "MissionProfileArn" + }, + "satelliteArn": { + "shape": "satelliteArn" + }, + "startTime": { + "shape": "Timestamp" + }, + "tags": { + "shape": "TagsMap" + } + } + }, + "DataflowEndpointConfig": { + "type": "structure", + "required": [ + "dataflowEndpointName" + ], + "members": { + "dataflowEndpointName": { + "shape": "String" + } + } + }, + "Uuid": { + "type": "string", + "min": 1, + "max": 128, + "pattern": "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + }, + "ListTagsForResourceResponse": { + "type": "structure", + "members": { + "tags": { + "shape": "TagsMap" + } + } + }, + "MissionProfileArn": { + "type": "string" + }, + "ListContactsResponse": { + "type": "structure", + "members": { + "contactList": { + "shape": "ContactList" + }, + "nextToken": { + "shape": "String" + } + } + }, + "DataflowEdgeList": { + "type": "list", + "member": { + "shape": "DataflowEdge" + } + }, + "DescribeContactResponse": { + "type": "structure", + "members": { + "contactId": { + "shape": "String" + }, + "contactStatus": { + "shape": "ContactStatus" + }, + "endTime": { + "shape": "Timestamp" + }, + "errorMessage": { + "shape": "String" + }, + "groundStation": { + "shape": "String" + }, + "maximumElevation": { + "shape": "Elevation" + }, + "missionProfileArn": { + "shape": "MissionProfileArn" + }, + "postPassEndTime": { + "shape": "Timestamp" + }, + "prePassStartTime": { + "shape": "Timestamp" + }, + "satelliteArn": { + "shape": "satelliteArn" + }, + "startTime": { + "shape": "Timestamp" + }, + "tags": { + "shape": "TagsMap" + } + } + }, + "ConfigListItem": { + "type": "structure", + "members": { + "configArn": { + "shape": "ConfigArn" + }, + "configId": { + "shape": "String" + }, + "configType": { + "shape": "ConfigCapabilityType" + }, + "name": { + "shape": "String" + } + } + }, + "ListTagsForResourceRequest": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "resourceArn": { + "shape": "String", + "location": "uri", + "locationName": "resourceArn" + } + } + }, + "ListDataflowEndpointGroupsRequest": { + "type": "structure", + "members": { + "maxResults": { + "shape": "Integer", + "location": "querystring", + "locationName": "maxResults" + }, + "nextToken": { + "shape": "String", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "FrequencyBandwidth": { + "type": "structure", + "required": [ + "units", + "value" + ], + "members": { + "units": { + "shape": "BandwidthUnits" + }, + "value": { + "shape": "Double" + } + } + }, + "String": { + "type": "string" + }, + "ListSatellitesRequest": { + "type": "structure", + "members": { + "maxResults": { + "shape": "Integer", + "location": "querystring", + "locationName": "maxResults" + }, + "nextToken": { + "shape": "String", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "UpdateMissionProfileRequest": { + "type": "structure", + "required": [ + "missionProfileId" + ], + "members": { + "contactPostPassDurationSeconds": { + "shape": "DurationInSeconds" + }, + "contactPrePassDurationSeconds": { + "shape": "DurationInSeconds" + }, + "dataflowEdges": { + "shape": "DataflowEdgeList" + }, + "minimumViableContactDurationSeconds": { + "shape": "DurationInSeconds" + }, + "missionProfileId": { + "shape": "String", + "location": "uri", + "locationName": "missionProfileId" + }, + "name": { + "shape": "SafeName" + }, + "trackingConfigArn": { + "shape": "ConfigArn" + } + } + }, + "FrequencyUnits": { + "type": "string", + "enum": [ + "GHz", + "MHz", + "kHz" + ] + }, + "TagResourceRequest": { + "type": "structure", + "required": [ + "resourceArn" + ], + "members": { + "resourceArn": { + "shape": "String", + "location": "uri", + "locationName": "resourceArn" + }, + "tags": { + "shape": "TagsMap" + } + } + }, + "Criticality": { + "type": "string", + "enum": [ + "PREFERRED", + "REMOVED", + "REQUIRED" + ] + }, + "ConfigCapabilityType": { + "type": "string", + "enum": [ + "antenna-downlink", + "antenna-downlink-demod-decode", + "antenna-uplink", + "dataflow-endpoint", + "tracking", + "uplink-echo" + ] + }, + "TagKeys": { + "type": "list", + "member": { + "shape": "String" + } + }, + "AngleUnits": { + "type": "string", + "enum": [ + "DEGREE_ANGLE", + "RADIAN" + ] + }, + "DataflowEndpointListItem": { + "type": "structure", + "members": { + "dataflowEndpointGroupArn": { + "shape": "DataflowEndpointGroupArn" + }, + "dataflowEndpointGroupId": { + "shape": "String" + } + } + }, + "GetDataflowEndpointGroupResponse": { + "type": "structure", + "members": { + "dataflowEndpointGroupArn": { + "shape": "DataflowEndpointGroupArn" + }, + "dataflowEndpointGroupId": { + "shape": "String" + }, + "endpointsDetails": { + "shape": "EndpointDetailsList" + }, + "tags": { + "shape": "TagsMap" + } + } + }, + "GetDataflowEndpointGroupRequest": { + "type": "structure", + "required": [ + "dataflowEndpointGroupId" + ], + "members": { + "dataflowEndpointGroupId": { + "shape": "String", + "location": "uri", + "locationName": "dataflowEndpointGroupId" + } + } + }, + "ConfigArn": { + "type": "string" + }, + "GetMinuteUsageRequest": { + "type": "structure", + "required": [ + "month", + "year" + ], + "members": { + "month": { + "shape": "Integer" + }, + "year": { + "shape": "Integer" + } + } + }, + "DataflowEndpointGroupIdResponse": { + "type": "structure", + "members": { + "dataflowEndpointGroupId": { + "shape": "String" + } + } + }, + "EirpUnits": { + "type": "string", + "enum": [ + "dBW" + ] + } + } +} \ No newline at end of file diff --git a/models/apis/groundstation/2019-05-23/docs-2.json b/models/apis/groundstation/2019-05-23/docs-2.json new file mode 100644 index 00000000000..4eafd0b90af --- /dev/null +++ b/models/apis/groundstation/2019-05-23/docs-2.json @@ -0,0 +1,769 @@ +{ + "version": "2.0", + "service": "

Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that\n enables you to control satellite communications, downlink and process satellite data, and\n scale your satellite operations efficiently and cost-effectively without having\n to build or manage your own ground station infrastructure.

", + "operations": { + "CancelContact": "

Cancels a contact with a specified contact ID.

", + "CreateConfig": "

Creates a Config with the specified configData parameters.

\n

Only one type of configData can be specified.

", + "CreateDataflowEndpointGroup": "

Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.

\n

The name field in each endpoint is used in your mission profile DataflowEndpointConfig \n to specify which endpoints to use during a contact.

\n

When a contact uses multiple DataflowEndpointConfig objects, each Config \n must match a DataflowEndpoint in the same group.

", + "CreateMissionProfile": "

Creates a mission profile.

\n

\n dataflowEdges is a list of lists of strings. Each lower level list of strings\n has two elements: a from ARN and a to ARN.

", + "DeleteConfig": "

Deletes a Config.

", + "DeleteDataflowEndpointGroup": "

Deletes a dataflow endpoint group.

", + "DeleteMissionProfile": "

Deletes a mission profile.

", + "DescribeContact": "

Describes an existing contact.

", + "GetConfig": "

Returns Config information.

\n

Only one Config response can be returned.

", + "GetDataflowEndpointGroup": "

Returns the dataflow endpoint group.

", + "GetMissionProfile": "

Returns a mission profile.

", + "ListConfigs": "

Returns a list of Config objects.

", + "ListContacts": "

Returns a list of contacts.

\n

If statusList contains AVAILABLE, the request must include\n groundstation, missionprofileArn, and satelliteArn.\n

", + "ListDataflowEndpointGroups": "

Returns a list of DataflowEndpoint groups.

", + "ListMissionProfiles": "

Returns a list of mission profiles.

", + "ReserveContact": "

Reserves a contact using specified parameters.

", + "UpdateConfig": "

Updates the Config used when scheduling contacts.

\n

Updating a Config will not update the execution parameters\n for existing future contacts scheduled with this Config.

", + "UpdateMissionProfile": "

Updates a mission profile.

\n

Updating a mission profile will not update the execution parameters\n for existing future contacts.

", + "GetMinuteUsage": "

Returns the number of minutes used by account.

", + "GetSatellite": "

Returns a satellite.

", + "ListGroundStations": "

Returns a list of ground stations.

", + "ListSatellites": "

Returns a list of satellites.

", + "ListTagsForResource": "

Returns a list of tags or a specified resource.

", + "TagResource": "

Assigns a tag to a resource.

", + "UntagResource": "

Deassigns a resource tag.

" + }, + "shapes": { + "AngleUnits": { + "base": null, + "refs": { } + }, + "AntennaDownlinkConfig": { + "base": "

Information about how AWS Ground Station should configure an\n antenna for downlink during a contact.

", + "refs": { + "AntennaDownlinkConfig$spectrumConfig": "

Object that describes a spectral Config.

" + } + }, + "AntennaDownlinkDemodDecodeConfig": { + "base": "

Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.

", + "refs": { + "AntennaDownlinkDemodDecodeConfig$decodeConfig": "

Information about the decode Config.

", + "AntennaDownlinkDemodDecodeConfig$demodulationConfig": "

Information about the demodulation Config.

", + "AntennaDownlinkDemodDecodeConfig$spectrumConfig": "

Information about the spectral Config.

" + } + }, + "AntennaUplinkConfig": { + "base": "

Information about the uplink Config of an antenna.

", + "refs": { + "AntennaUplinkConfig$spectrumConfig": "

Information about the uplink spectral Config.

", + "AntennaUplinkConfig$targetEirp": "

EIRP of the target.

" + } + }, + "BandwidthUnits": { + "base": null, + "refs": { } + }, + "Boolean": { + "base": null, + "refs": { } + }, + "CancelContactRequest": { + "base": "

", + "refs": { + "CancelContactRequest$contactId": "

UUID of a contact.

" + } + }, + "ConfigArn": { + "base": null, + "refs": { } + }, + "ConfigCapabilityType": { + "base": null, + "refs": { } + }, + "ConfigIdResponse": { + "base": "

", + "refs": { + "ConfigIdResponse$configArn": "

ARN of a Config.

", + "ConfigIdResponse$configId": "

UUID of a Config.

", + "ConfigIdResponse$configType": "

Type of a Config.

" + } + }, + "ConfigList": { + "base": null, + "refs": { + "ConfigList$member": null + } + }, + "ConfigListItem": { + "base": "

An item in a list of Config objects.

", + "refs": { + "ConfigListItem$configArn": "

ARN of a Config.

", + "ConfigListItem$configId": "

UUID of a Config.

", + "ConfigListItem$configType": "

Type of a Config.

", + "ConfigListItem$name": "

Name of a Config.

" + } + }, + "ConfigTypeData": { + "base": "

Object containing the parameters for a Config.

\n

See the subtype definitions for what each type of Config contains.

", + "refs": { + "ConfigTypeData$antennaDownlinkConfig": "

Information about how AWS Ground Station should configure an antenna for downlink during a contact.

", + "ConfigTypeData$antennaDownlinkDemodDecodeConfig": "

Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.

", + "ConfigTypeData$antennaUplinkConfig": "

Information about how AWS Ground Station should configure an antenna for uplink during a contact.

", + "ConfigTypeData$dataflowEndpointConfig": "

Information about the dataflow endpoint Config.

", + "ConfigTypeData$trackingConfig": "

Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.

", + "ConfigTypeData$uplinkEchoConfig": "

Information about an uplink echo Config.

\n

Parameters from the AntennaUplinkConfig, corresponding to the specified AntennaUplinkConfigArn, are used when this UplinkEchoConfig is used in a contact.

" + } + }, + "ContactData": { + "base": "

Data describing a contact.

", + "refs": { + "ContactData$contactId": "

UUID of a contact.

", + "ContactData$contactStatus": "

Status of a contact.

", + "ContactData$endTime": "

End time of a contact.

", + "ContactData$errorMessage": "

Error message of a contact.

", + "ContactData$groundStation": "

Name of a ground station.

", + "ContactData$maximumElevation": "

Maximum elevation angle of a contact.

", + "ContactData$missionProfileArn": "

ARN of a mission profile.

", + "ContactData$postPassEndTime": "

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

", + "ContactData$prePassStartTime": "

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

", + "ContactData$satelliteArn": "

ARN of a satellite.

", + "ContactData$startTime": "

Start time of a contact.

", + "ContactData$tags": "

Tags assigned to a contact.

" + } + }, + "ContactIdResponse": { + "base": "

", + "refs": { + "ContactIdResponse$contactId": "

UUID of a contact.

" + } + }, + "ContactList": { + "base": null, + "refs": { + "ContactList$member": null + } + }, + "ContactStatus": { + "base": null, + "refs": { } + }, + "CreateConfigRequest": { + "base": "

", + "refs": { + "CreateConfigRequest$configData": "

Parameters of a Config.

", + "CreateConfigRequest$name": "

Name of a Config.

", + "CreateConfigRequest$tags": "

Tags assigned to a Config.

" + } + }, + "CreateDataflowEndpointGroupRequest": { + "base": "

", + "refs": { + "CreateDataflowEndpointGroupRequest$endpointDetails": "

Endpoint details of each endpoint in the dataflow endpoint group.

", + "CreateDataflowEndpointGroupRequest$tags": "

Tags of a dataflow endpoint group.

" + } + }, + "CreateMissionProfileRequest": { + "base": "

", + "refs": { + "CreateMissionProfileRequest$contactPostPassDurationSeconds": "

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

", + "CreateMissionProfileRequest$contactPrePassDurationSeconds": "

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

", + "CreateMissionProfileRequest$dataflowEdges": "

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to \n Config.

", + "CreateMissionProfileRequest$minimumViableContactDurationSeconds": "

Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.

", + "CreateMissionProfileRequest$name": "

Name of a mission profile.

", + "CreateMissionProfileRequest$tags": "

Tags assigned to a mission profile.

", + "CreateMissionProfileRequest$trackingConfigArn": "

ARN of a tracking Config.

" + } + }, + "Criticality": { + "base": null, + "refs": { } + }, + "DataflowEdge": { + "base": null, + "refs": { + "DataflowEdge$member": null + } + }, + "DataflowEdgeList": { + "base": null, + "refs": { + "DataflowEdgeList$member": null + } + }, + "DataflowEndpoint": { + "base": "

Information about a dataflow endpoint.

", + "refs": { + "DataflowEndpoint$address": "

Socket address of a dataflow endpoint.

", + "DataflowEndpoint$name": "

Name of a dataflow endpoint.

", + "DataflowEndpoint$status": "

Status of a dataflow endpoint.

" + } + }, + "DataflowEndpointConfig": { + "base": "

Information about the dataflow endpoint Config.

", + "refs": { + "DataflowEndpointConfig$dataflowEndpointName": "

Name of a dataflow endpoint.

" + } + }, + "DataflowEndpointGroupArn": { + "base": null, + "refs": { } + }, + "DataflowEndpointGroupIdResponse": { + "base": "

", + "refs": { + "DataflowEndpointGroupIdResponse$dataflowEndpointGroupId": "

ID of a dataflow endpoint group.

" + } + }, + "DataflowEndpointGroupList": { + "base": null, + "refs": { + "DataflowEndpointGroupList$member": null + } + }, + "DataflowEndpointListItem": { + "base": "

Item in a list of DataflowEndpoint groups.

", + "refs": { + "DataflowEndpointListItem$dataflowEndpointGroupArn": "

ARN of a dataflow endpoint group.

", + "DataflowEndpointListItem$dataflowEndpointGroupId": "

UUID of a dataflow endpoint group.

" + } + }, + "DecodeConfig": { + "base": "

Information about the decode Config.

", + "refs": { + "DecodeConfig$unvalidatedJSON": "

Unvalidated JSON of a decode Config.

" + } + }, + "DeleteConfigRequest": { + "base": "

", + "refs": { + "DeleteConfigRequest$configId": "

UUID of a Config.

", + "DeleteConfigRequest$configType": "

Type of a Config.

" + } + }, + "DeleteDataflowEndpointGroupRequest": { + "base": "

", + "refs": { + "DeleteDataflowEndpointGroupRequest$dataflowEndpointGroupId": "

ID of a dataflow endpoint group.

" + } + }, + "DeleteMissionProfileRequest": { + "base": "

", + "refs": { + "DeleteMissionProfileRequest$missionProfileId": "

UUID of a mission profile.

" + } + }, + "DemodulationConfig": { + "base": "

Information about the demodulation Config.

", + "refs": { + "DemodulationConfig$unvalidatedJSON": "

Unvalidated JSON of a demodulation Config.

" + } + }, + "DependencyException": { + "base": "

Dependency encountered an error.

", + "refs": { + "DependencyException$parameterName": "

" + } + }, + "DescribeContactRequest": { + "base": "

", + "refs": { + "DescribeContactRequest$contactId": "

UUID of a contact.

" + } + }, + "DescribeContactResponse": { + "base": "

", + "refs": { + "DescribeContactResponse$contactId": "

UUID of a contact.

", + "DescribeContactResponse$contactStatus": "

Status of a contact.

", + "DescribeContactResponse$endTime": "

End time of a contact.

", + "DescribeContactResponse$errorMessage": "

Error message for a contact.

", + "DescribeContactResponse$groundStation": "

Ground station for a contact.

", + "DescribeContactResponse$maximumElevation": "

Maximum elevation angle of a contact.

", + "DescribeContactResponse$missionProfileArn": "

ARN of a mission profile.

", + "DescribeContactResponse$postPassEndTime": "

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

", + "DescribeContactResponse$prePassStartTime": "

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

", + "DescribeContactResponse$satelliteArn": "

ARN of a satellite.

", + "DescribeContactResponse$startTime": "

Start time of a contact.

", + "DescribeContactResponse$tags": "

Tags assigned to a contact.

" + } + }, + "Double": { + "base": null, + "refs": { } + }, + "DurationInSeconds": { + "base": null, + "refs": { } + }, + "Eirp": { + "base": "

Object that represents EIRP.

", + "refs": { + "Eirp$units": "

Units of an EIRP.

", + "Eirp$value": "

Value of an EIRP.

" + } + }, + "EirpUnits": { + "base": null, + "refs": { } + }, + "Elevation": { + "base": "

Elevation angle of the satellite in the sky during a contact.

", + "refs": { + "Elevation$unit": "

Elevation angle units.

", + "Elevation$value": "

Elevation angle value.

" + } + }, + "EndpointDetails": { + "base": "

Information about the endpoint details.

", + "refs": { + "EndpointDetails$endpoint": "

A dataflow endpoint.

", + "EndpointDetails$securityDetails": "

Endpoint security details.

" + } + }, + "EndpointDetailsList": { + "base": null, + "refs": { + "EndpointDetailsList$member": null + } + }, + "EndpointStatus": { + "base": null, + "refs": { } + }, + "Frequency": { + "base": "

Object that describes the frequency.

", + "refs": { + "Frequency$units": "

Frequency units.

", + "Frequency$value": "

Frequency value.

" + } + }, + "FrequencyBandwidth": { + "base": "

Object that describes the frequency bandwidth.

", + "refs": { + "FrequencyBandwidth$units": "

Frequency bandwidth units.

", + "FrequencyBandwidth$value": "

Frequency bandwidth value.

" + } + }, + "FrequencyUnits": { + "base": null, + "refs": { } + }, + "GetConfigRequest": { + "base": "

", + "refs": { + "GetConfigRequest$configId": "

UUID of a Config.

", + "GetConfigRequest$configType": "

Type of a Config.

" + } + }, + "GetConfigResponse": { + "base": "

", + "refs": { + "GetConfigResponse$configArn": "

ARN of a Config\n

", + "GetConfigResponse$configData": "

Data elements in a Config.

", + "GetConfigResponse$configId": "

UUID of a Config.

", + "GetConfigResponse$configType": "

Type of a Config.

", + "GetConfigResponse$name": "

Name of a Config.

", + "GetConfigResponse$tags": "

Tags assigned to a Config.

" + } + }, + "GetDataflowEndpointGroupRequest": { + "base": "

", + "refs": { + "GetDataflowEndpointGroupRequest$dataflowEndpointGroupId": "

UUID of a dataflow endpoint group.

" + } + }, + "GetDataflowEndpointGroupResponse": { + "base": "

", + "refs": { + "GetDataflowEndpointGroupResponse$dataflowEndpointGroupArn": "

ARN of a dataflow endpoint group.

", + "GetDataflowEndpointGroupResponse$dataflowEndpointGroupId": "

UUID of a dataflow endpoint group.

", + "GetDataflowEndpointGroupResponse$endpointsDetails": "

Details of a dataflow endpoint.

", + "GetDataflowEndpointGroupResponse$tags": "

Tags assigned to a dataflow endpoint group.

" + } + }, + "GetMinuteUsageRequest": { + "base": "

", + "refs": { + "GetMinuteUsageRequest$month": "

The month being requested, with a value of 1-12.

", + "GetMinuteUsageRequest$year": "

The year being requested, in the format of YYYY.

" + } + }, + "GetMinuteUsageResponse": { + "base": "

", + "refs": { + "GetMinuteUsageResponse$estimatedMinutesRemaining": "

Estimated number of minutes remaining for an account, specific to the month being requested.

", + "GetMinuteUsageResponse$isReservedMinutesCustomer": "

Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.

", + "GetMinuteUsageResponse$totalReservedMinuteAllocation": "

Total number of reserved minutes allocated, specific to the month being requested.

", + "GetMinuteUsageResponse$totalScheduledMinutes": "

Total scheduled minutes for an account, specific to the month being requested.

", + "GetMinuteUsageResponse$upcomingMinutesScheduled": "

Upcoming minutes scheduled for an account, specific to the month being requested.

" + } + }, + "GetMissionProfileRequest": { + "base": "

", + "refs": { + "GetMissionProfileRequest$missionProfileId": "

UUID of a mission profile.

" + } + }, + "GetMissionProfileResponse": { + "base": "

", + "refs": { + "GetMissionProfileResponse$contactPostPassDurationSeconds": "

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

", + "GetMissionProfileResponse$contactPrePassDurationSeconds": "

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

", + "GetMissionProfileResponse$dataflowEdges": "

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to \n Config.

", + "GetMissionProfileResponse$minimumViableContactDurationSeconds": "

Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.

", + "GetMissionProfileResponse$missionProfileArn": "

ARN of a mission profile.

", + "GetMissionProfileResponse$missionProfileId": "

ID of a mission profile.

", + "GetMissionProfileResponse$name": "

Name of a mission profile.

", + "GetMissionProfileResponse$region": "

Region of a mission profile.

", + "GetMissionProfileResponse$tags": "

Tags assigned to a mission profile.

", + "GetMissionProfileResponse$trackingConfigArn": "

ARN of a tracking Config.

" + } + }, + "GetSatelliteRequest": { + "base": "

", + "refs": { + "GetSatelliteRequest$satelliteId": "

UUID of a satellite.

" + } + }, + "GetSatelliteResponse": { + "base": "

", + "refs": { + "GetSatelliteResponse$dateCreated": "

When a satellite was created.

", + "GetSatelliteResponse$lastUpdated": "

When a satellite was last updated.

", + "GetSatelliteResponse$noradSatelliteID": "

NORAD satellite ID number.

", + "GetSatelliteResponse$satelliteArn": "

ARN of a satellite.

", + "GetSatelliteResponse$satelliteId": "

UUID of a satellite.

", + "GetSatelliteResponse$tags": "

Tags assigned to a satellite.

" + } + }, + "GroundStationData": { + "base": "

Information about the ground station data.

", + "refs": { + "GroundStationData$groundStationId": "

ID of a ground station.

", + "GroundStationData$groundStationName": "

Name of a ground station.

", + "GroundStationData$region": "

Ground station Region.

" + } + }, + "GroundStationList": { + "base": null, + "refs": { + "GroundStationList$member": null + } + }, + "Integer": { + "base": null, + "refs": { } + }, + "InvalidParameterException": { + "base": "

One or more parameters are not valid.

", + "refs": { + "InvalidParameterException$parameterName": "

" + } + }, + "JsonString": { + "base": null, + "refs": { } + }, + "ListConfigsRequest": { + "base": "

", + "refs": { + "ListConfigsRequest$maxResults": "

Maximum number of Configs returned.

", + "ListConfigsRequest$nextToken": "

Next token returned in the request of a previous ListConfigs call. Used to get the next page of results.

" + } + }, + "ListConfigsResponse": { + "base": "

", + "refs": { + "ListConfigsResponse$configList": "

List of Config items.

", + "ListConfigsResponse$nextToken": "

Next token returned in the response of a previous ListConfigs call. Used to get the next page of results.

" + } + }, + "ListContactsRequest": { + "base": "

", + "refs": { + "ListContactsRequest$endTime": "

End time of a contact.

", + "ListContactsRequest$groundStation": "

Name of a ground station.

", + "ListContactsRequest$maxResults": "

Maximum number of contacts returned.

", + "ListContactsRequest$missionProfileArn": "

ARN of a mission profile.

", + "ListContactsRequest$nextToken": "

Next token returned in the request of a previous ListContacts call. Used to get the next page of results.

", + "ListContactsRequest$satelliteArn": "

ARN of a satellite.

", + "ListContactsRequest$startTime": "

Start time of a contact.

", + "ListContactsRequest$statusList": "

Status of a contact reservation.

" + } + }, + "ListContactsResponse": { + "base": "

", + "refs": { + "ListContactsResponse$contactList": "

List of contacts.

", + "ListContactsResponse$nextToken": "

Next token returned in the response of a previous ListContacts call. Used to get the next page of results.

" + } + }, + "ListDataflowEndpointGroupsRequest": { + "base": "

", + "refs": { + "ListDataflowEndpointGroupsRequest$maxResults": "

Maximum number of dataflow endpoint groups returned.

", + "ListDataflowEndpointGroupsRequest$nextToken": "

Next token returned in the request of a previous ListDataflowEndpointGroups call. Used to get the next page of results.

" + } + }, + "ListDataflowEndpointGroupsResponse": { + "base": "

", + "refs": { + "ListDataflowEndpointGroupsResponse$dataflowEndpointGroupList": "

A list of dataflow endpoint groups.

", + "ListDataflowEndpointGroupsResponse$nextToken": "

Next token returned in the response of a previous ListDataflowEndpointGroups call. Used to get the next page of results.

" + } + }, + "ListGroundStationsRequest": { + "base": "

", + "refs": { + "ListGroundStationsRequest$maxResults": "

Maximum number of ground stations returned.

", + "ListGroundStationsRequest$nextToken": "

Next token that can be supplied in the next call to get the next page of ground stations.

" + } + }, + "ListGroundStationsResponse": { + "base": "

", + "refs": { + "ListGroundStationsResponse$groundStationList": "

List of ground stations.

", + "ListGroundStationsResponse$nextToken": "

Next token that can be supplied in the next call to get the next page of ground stations.

" + } + }, + "ListMissionProfilesRequest": { + "base": "

", + "refs": { + "ListMissionProfilesRequest$maxResults": "

Maximum number of mission profiles returned.

", + "ListMissionProfilesRequest$nextToken": "

Next token returned in the request of a previous ListMissionProfiles call. Used to get the next page of results.

" + } + }, + "ListMissionProfilesResponse": { + "base": "

", + "refs": { + "ListMissionProfilesResponse$missionProfileList": "

List of mission profiles

", + "ListMissionProfilesResponse$nextToken": "

Next token returned in the response of a previous ListMissionProfiles call. Used to get the next page of results.

" + } + }, + "ListSatellitesRequest": { + "base": "

", + "refs": { + "ListSatellitesRequest$maxResults": "

Maximum number of satellites returned.

", + "ListSatellitesRequest$nextToken": "

Next token that can be supplied in the next call to get the next page of satellites.

" + } + }, + "ListSatellitesResponse": { + "base": "

", + "refs": { + "ListSatellitesResponse$nextToken": "

Next token that can be supplied in the next call to get the next page of satellites.

", + "ListSatellitesResponse$satellites": "

List of satellites.

" + } + }, + "ListTagsForResourceRequest": { + "base": "

", + "refs": { + "ListTagsForResourceRequest$resourceArn": "

ARN of a resource.

" + } + }, + "ListTagsForResourceResponse": { + "base": "

", + "refs": { + "ListTagsForResourceResponse$tags": "

Tags assigned to a resource.

" + } + }, + "MissionProfileArn": { + "base": null, + "refs": { } + }, + "MissionProfileIdResponse": { + "base": "

", + "refs": { + "MissionProfileIdResponse$missionProfileId": "

ID of a mission profile.

" + } + }, + "MissionProfileList": { + "base": null, + "refs": { + "MissionProfileList$member": null + } + }, + "MissionProfileListItem": { + "base": "

Item in a list of mission profiles.

", + "refs": { + "MissionProfileListItem$missionProfileArn": "

ARN of a mission profile.

", + "MissionProfileListItem$missionProfileId": "

ID of a mission profile.

", + "MissionProfileListItem$name": "

Name of a mission profile.

", + "MissionProfileListItem$region": "

Region of a mission profile.

" + } + }, + "Polarization": { + "base": null, + "refs": { } + }, + "ReserveContactRequest": { + "base": "

", + "refs": { + "ReserveContactRequest$endTime": "

End time of a contact.

", + "ReserveContactRequest$groundStation": "

Name of a ground station.

", + "ReserveContactRequest$missionProfileArn": "

ARN of a mission profile.

", + "ReserveContactRequest$satelliteArn": "

ARN of a satellite

", + "ReserveContactRequest$startTime": "

Start time of a contact.

", + "ReserveContactRequest$tags": "

Tags assigned to a contact.

" + } + }, + "ResourceNotFoundException": { + "base": "

Resource was not found.

", + "refs": { } + }, + "RoleArn": { + "base": null, + "refs": { } + }, + "SafeName": { + "base": null, + "refs": { } + }, + "SatelliteList": { + "base": null, + "refs": { + "SatelliteList$member": null + } + }, + "SatelliteListItem": { + "base": "

Item in a list of satellites.

", + "refs": { + "SatelliteListItem$noradSatelliteID": "

NORAD satellite ID number.

", + "SatelliteListItem$satelliteArn": "

ARN of a satellite.

", + "SatelliteListItem$satelliteId": "

ID of a satellite.

" + } + }, + "SecurityDetails": { + "base": "

Information about endpoints.

", + "refs": { + "SecurityDetails$roleArn": "

ARN to a role needed for connecting streams to your instances.

", + "SecurityDetails$securityGroupIds": "

The security groups to attach to the elastic network interfaces.

", + "SecurityDetails$subnetIds": "

A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.

" + } + }, + "SecurityGroupIdList": { + "base": null, + "refs": { + "SecurityGroupIdList$member": null + } + }, + "SocketAddress": { + "base": "

Information about the socket address.

", + "refs": { + "SocketAddress$name": "

Name of a socket address.

", + "SocketAddress$port": "

Port of a socket address.

" + } + }, + "SpectrumConfig": { + "base": "

Object that describes a spectral Config.

", + "refs": { + "SpectrumConfig$bandwidth": "

Bandwidth of a spectral Config.

", + "SpectrumConfig$centerFrequency": "

Center frequency of a spectral Config.

", + "SpectrumConfig$polarization": "

Polarization of a spectral Config.

" + } + }, + "StatusList": { + "base": null, + "refs": { + "StatusList$member": null + } + }, + "String": { + "base": null, + "refs": { } + }, + "SubnetList": { + "base": null, + "refs": { + "SubnetList$member": null + } + }, + "TagKeys": { + "base": null, + "refs": { + "TagKeys$member": null + } + }, + "TagResourceRequest": { + "base": "

", + "refs": { + "TagResourceRequest$resourceArn": "

ARN of a resource tag.

", + "TagResourceRequest$tags": "

Tags assigned to a resource.

" + } + }, + "TagResourceResponse": { + "base": "

", + "refs": { } + }, + "TagsMap": { + "base": null, + "refs": { + "TagsMap$key": null, + "TagsMap$value": null + } + }, + "Timestamp": { + "base": null, + "refs": { } + }, + "TrackingConfig": { + "base": "

Object that determines whether tracking should be used during a contact\n executed with this Config in the mission profile.

", + "refs": { + "TrackingConfig$autotrack": "

Current setting for autotrack.

" + } + }, + "UntagResourceRequest": { + "base": "

", + "refs": { + "UntagResourceRequest$resourceArn": "

ARN of a resource.

", + "UntagResourceRequest$tagKeys": "

Keys of a resource tag.

" + } + }, + "UntagResourceResponse": { + "base": "

", + "refs": { } + }, + "UpdateConfigRequest": { + "base": "

", + "refs": { + "UpdateConfigRequest$configData": "

Parameters for a Config.

", + "UpdateConfigRequest$configId": "

UUID of a Config.

", + "UpdateConfigRequest$configType": "

Type of a Config.

", + "UpdateConfigRequest$name": "

Name of a Config.

" + } + }, + "UpdateMissionProfileRequest": { + "base": "

", + "refs": { + "UpdateMissionProfileRequest$contactPostPassDurationSeconds": "

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

", + "UpdateMissionProfileRequest$contactPrePassDurationSeconds": "

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

", + "UpdateMissionProfileRequest$dataflowEdges": "

A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to \n Config.

", + "UpdateMissionProfileRequest$minimumViableContactDurationSeconds": "

Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.

", + "UpdateMissionProfileRequest$missionProfileId": "

ID of a mission profile.

", + "UpdateMissionProfileRequest$name": "

Name of a mission profile.

", + "UpdateMissionProfileRequest$trackingConfigArn": "

ARN of a tracking Config.

" + } + }, + "UplinkEchoConfig": { + "base": "

Information about an uplink echo Config.

\n

Parameters from the AntennaUplinkConfig, corresponding to the \n specified AntennaUplinkConfigArn, are used when this UplinkEchoConfig \n is used in a contact.

", + "refs": { + "UplinkEchoConfig$antennaUplinkConfigArn": "

ARN of an uplink Config.

", + "UplinkEchoConfig$enabled": "

Whether or not an uplink Config is enabled.

" + } + }, + "UplinkSpectrumConfig": { + "base": "

Information about the uplink spectral Config.

", + "refs": { + "UplinkSpectrumConfig$centerFrequency": "

Center frequency of an uplink spectral Config.

", + "UplinkSpectrumConfig$polarization": "

Polarization of an uplink spectral Config.

" + } + }, + "Uuid": { + "base": null, + "refs": { } + }, + "noradSatelliteID": { + "base": null, + "refs": { } + }, + "satelliteArn": { + "base": null, + "refs": { } + } + } +} \ No newline at end of file diff --git a/models/apis/groundstation/2019-05-23/examples-1.json b/models/apis/groundstation/2019-05-23/examples-1.json new file mode 100644 index 00000000000..752e89e032e --- /dev/null +++ b/models/apis/groundstation/2019-05-23/examples-1.json @@ -0,0 +1,4 @@ +{ + "version": "1.0", + "examples": { } +} \ No newline at end of file diff --git a/models/apis/groundstation/2019-05-23/paginators-1.json b/models/apis/groundstation/2019-05-23/paginators-1.json new file mode 100644 index 00000000000..c9d1ca95baf --- /dev/null +++ b/models/apis/groundstation/2019-05-23/paginators-1.json @@ -0,0 +1,40 @@ +{ + "pagination": { + "ListConfigs": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "configList" + }, + "ListContacts": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "contactList" + }, + "ListDataflowEndpointGroups": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "dataflowEndpointGroupList" + }, + "ListMissionProfiles": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "missionProfileList" + }, + "ListGroundStations": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "groundStationList" + }, + "ListSatellites": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "satellites" + } + } +} \ No newline at end of file diff --git a/models/apis/pinpoint-email/2018-07-26/api-2.json b/models/apis/pinpoint-email/2018-07-26/api-2.json index 7d80fab9976..ac7d38502ab 100644 --- a/models/apis/pinpoint-email/2018-07-26/api-2.json +++ b/models/apis/pinpoint-email/2018-07-26/api-2.json @@ -268,6 +268,20 @@ {"shape":"BadRequestException"} ] }, + "GetDomainDeliverabilityCampaign":{ + "name":"GetDomainDeliverabilityCampaign", + "http":{ + "method":"GET", + "requestUri":"/v1/email/deliverability-dashboard/campaigns/{CampaignId}" + }, + "input":{"shape":"GetDomainDeliverabilityCampaignRequest"}, + "output":{"shape":"GetDomainDeliverabilityCampaignResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ] + }, "GetDomainStatisticsReport":{ "name":"GetDomainStatisticsReport", "http":{ @@ -336,6 +350,20 @@ {"shape":"BadRequestException"} ] }, + "ListDomainDeliverabilityCampaigns":{ + "name":"ListDomainDeliverabilityCampaigns", + "http":{ + "method":"GET", + "requestUri":"/v1/email/deliverability-dashboard/domains/{SubscribedDomain}/campaigns" + }, + "input":{"shape":"ListDomainDeliverabilityCampaignsRequest"}, + "output":{"shape":"ListDomainDeliverabilityCampaignsResponse"}, + "errors":[ + {"shape":"TooManyRequestsException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ] + }, "ListEmailIdentities":{ "name":"ListEmailIdentities", "http":{ @@ -655,6 +683,7 @@ "Html":{"shape":"Content"} } }, + "CampaignId":{"type":"string"}, "Charset":{"type":"string"}, "CloudWatchDestination":{ "type":"structure", @@ -724,6 +753,7 @@ }, "CreateConfigurationSetRequest":{ "type":"structure", + "required":["ConfigurationSetName"], "members":{ "ConfigurationSetName":{"shape":"ConfigurationSetName"}, "TrackingOptions":{"shape":"TrackingOptions"}, @@ -895,6 +925,14 @@ "members":{ } }, + "DeliverabilityDashboardAccountStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "PENDING_EXPIRATION", + "DISABLED" + ] + }, "DeliverabilityTestReport":{ "type":"structure", "members":{ @@ -964,6 +1002,42 @@ "type":"list", "member":{"shape":"DnsToken"} }, + "Domain":{"type":"string"}, + "DomainDeliverabilityCampaign":{ + "type":"structure", + "members":{ + "CampaignId":{"shape":"CampaignId"}, + "ImageUrl":{"shape":"ImageUrl"}, + "Subject":{"shape":"Subject"}, + "FromAddress":{"shape":"Identity"}, + "SendingIps":{"shape":"IpList"}, + "FirstSeenDateTime":{"shape":"Timestamp"}, + "LastSeenDateTime":{"shape":"Timestamp"}, + "InboxCount":{"shape":"Volume"}, + "SpamCount":{"shape":"Volume"}, + "ReadRate":{"shape":"Percentage"}, + "DeleteRate":{"shape":"Percentage"}, + "ReadDeleteRate":{"shape":"Percentage"}, + "ProjectedVolume":{"shape":"Volume"}, + "Esps":{"shape":"Esps"} + } + }, + "DomainDeliverabilityCampaignList":{ + "type":"list", + "member":{"shape":"DomainDeliverabilityCampaign"} + }, + "DomainDeliverabilityTrackingOption":{ + "type":"structure", + "members":{ + "Domain":{"shape":"Domain"}, + "SubscriptionStartDate":{"shape":"Timestamp"}, + "InboxPlacementTrackingOption":{"shape":"InboxPlacementTrackingOption"} + } + }, + "DomainDeliverabilityTrackingOptions":{ + "type":"list", + "member":{"shape":"DomainDeliverabilityTrackingOption"} + }, "DomainIspPlacement":{ "type":"structure", "members":{ @@ -991,6 +1065,11 @@ } }, "Enabled":{"type":"boolean"}, + "Esp":{"type":"string"}, + "Esps":{ + "type":"list", + "member":{"shape":"Esp"} + }, "EventDestination":{ "type":"structure", "required":[ @@ -1060,7 +1139,11 @@ "type":"structure", "required":["BlacklistItemNames"], "members":{ - "BlacklistItemNames":{"shape":"BlacklistItemNames"} + "BlacklistItemNames":{ + "shape":"BlacklistItemNames", + "location":"querystring", + "locationName":"BlacklistItemNames" + } } }, "GetBlacklistReportsResponse":{ @@ -1105,7 +1188,8 @@ "TrackingOptions":{"shape":"TrackingOptions"}, "DeliveryOptions":{"shape":"DeliveryOptions"}, "ReputationOptions":{"shape":"ReputationOptions"}, - "SendingOptions":{"shape":"SendingOptions"} + "SendingOptions":{"shape":"SendingOptions"}, + "Tags":{"shape":"TagList"} } }, "GetDedicatedIpRequest":{ @@ -1128,9 +1212,21 @@ "GetDedicatedIpsRequest":{ "type":"structure", "members":{ - "PoolName":{"shape":"PoolName"}, - "NextToken":{"shape":"NextToken"}, - "PageSize":{"shape":"MaxItems"} + "PoolName":{ + "shape":"PoolName", + "location":"querystring", + "locationName":"PoolName" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "PageSize":{ + "shape":"MaxItems", + "location":"querystring", + "locationName":"PageSize" + } } }, "GetDedicatedIpsResponse":{ @@ -1149,7 +1245,11 @@ "type":"structure", "required":["DashboardEnabled"], "members":{ - "DashboardEnabled":{"shape":"Enabled"} + "DashboardEnabled":{"shape":"Enabled"}, + "SubscriptionExpiryDate":{"shape":"Timestamp"}, + "AccountStatus":{"shape":"DeliverabilityDashboardAccountStatus"}, + "ActiveSubscribedDomains":{"shape":"DomainDeliverabilityTrackingOptions"}, + "PendingExpirationSubscribedDomains":{"shape":"DomainDeliverabilityTrackingOptions"} } }, "GetDeliverabilityTestReportRequest":{ @@ -1174,7 +1274,26 @@ "DeliverabilityTestReport":{"shape":"DeliverabilityTestReport"}, "OverallPlacement":{"shape":"PlacementStatistics"}, "IspPlacements":{"shape":"IspPlacements"}, - "Message":{"shape":"MessageContent"} + "Message":{"shape":"MessageContent"}, + "Tags":{"shape":"TagList"} + } + }, + "GetDomainDeliverabilityCampaignRequest":{ + "type":"structure", + "required":["CampaignId"], + "members":{ + "CampaignId":{ + "shape":"CampaignId", + "location":"uri", + "locationName":"CampaignId" + } + } + }, + "GetDomainDeliverabilityCampaignResponse":{ + "type":"structure", + "required":["DomainDeliverabilityCampaign"], + "members":{ + "DomainDeliverabilityCampaign":{"shape":"DomainDeliverabilityCampaign"} } }, "GetDomainStatisticsReportRequest":{ @@ -1190,8 +1309,16 @@ "location":"uri", "locationName":"Domain" }, - "StartDate":{"shape":"Timestamp"}, - "EndDate":{"shape":"Timestamp"} + "StartDate":{ + "shape":"Timestamp", + "location":"querystring", + "locationName":"StartDate" + }, + "EndDate":{ + "shape":"Timestamp", + "location":"querystring", + "locationName":"EndDate" + } } }, "GetDomainStatisticsReportResponse":{ @@ -1223,7 +1350,8 @@ "FeedbackForwardingStatus":{"shape":"Enabled"}, "VerifiedForSendingStatus":{"shape":"Enabled"}, "DkimAttributes":{"shape":"DkimAttributes"}, - "MailFromAttributes":{"shape":"MailFromAttributes"} + "MailFromAttributes":{"shape":"MailFromAttributes"}, + "Tags":{"shape":"TagList"} } }, "Identity":{"type":"string"}, @@ -1247,8 +1375,24 @@ "MANAGED_DOMAIN" ] }, + "ImageUrl":{"type":"string"}, + "InboxPlacementTrackingOption":{ + "type":"structure", + "members":{ + "Global":{"shape":"Enabled"}, + "TrackedIsps":{"shape":"IspNameList"} + } + }, "Ip":{"type":"string"}, + "IpList":{ + "type":"list", + "member":{"shape":"Ip"} + }, "IspName":{"type":"string"}, + "IspNameList":{ + "type":"list", + "member":{"shape":"IspName"} + }, "IspPlacement":{ "type":"structure", "members":{ @@ -1282,8 +1426,16 @@ "ListConfigurationSetsRequest":{ "type":"structure", "members":{ - "NextToken":{"shape":"NextToken"}, - "PageSize":{"shape":"MaxItems"} + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "PageSize":{ + "shape":"MaxItems", + "location":"querystring", + "locationName":"PageSize" + } } }, "ListConfigurationSetsResponse":{ @@ -1296,8 +1448,16 @@ "ListDedicatedIpPoolsRequest":{ "type":"structure", "members":{ - "NextToken":{"shape":"NextToken"}, - "PageSize":{"shape":"MaxItems"} + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "PageSize":{ + "shape":"MaxItems", + "location":"querystring", + "locationName":"PageSize" + } } }, "ListDedicatedIpPoolsResponse":{ @@ -1310,8 +1470,16 @@ "ListDeliverabilityTestReportsRequest":{ "type":"structure", "members":{ - "NextToken":{"shape":"NextToken"}, - "PageSize":{"shape":"MaxItems"} + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "PageSize":{ + "shape":"MaxItems", + "location":"querystring", + "locationName":"PageSize" + } } }, "ListDeliverabilityTestReportsResponse":{ @@ -1322,11 +1490,62 @@ "NextToken":{"shape":"NextToken"} } }, + "ListDomainDeliverabilityCampaignsRequest":{ + "type":"structure", + "required":[ + "StartDate", + "EndDate", + "SubscribedDomain" + ], + "members":{ + "StartDate":{ + "shape":"Timestamp", + "location":"querystring", + "locationName":"StartDate" + }, + "EndDate":{ + "shape":"Timestamp", + "location":"querystring", + "locationName":"EndDate" + }, + "SubscribedDomain":{ + "shape":"Domain", + "location":"uri", + "locationName":"SubscribedDomain" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "PageSize":{ + "shape":"MaxItems", + "location":"querystring", + "locationName":"PageSize" + } + } + }, + "ListDomainDeliverabilityCampaignsResponse":{ + "type":"structure", + "required":["DomainDeliverabilityCampaigns"], + "members":{ + "DomainDeliverabilityCampaigns":{"shape":"DomainDeliverabilityCampaignList"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListEmailIdentitiesRequest":{ "type":"structure", "members":{ - "NextToken":{"shape":"NextToken"}, - "PageSize":{"shape":"MaxItems"} + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"NextToken" + }, + "PageSize":{ + "shape":"MaxItems", + "location":"querystring", + "locationName":"PageSize" + } } }, "ListEmailIdentitiesResponse":{ @@ -1344,7 +1563,11 @@ "type":"structure", "required":["ResourceArn"], "members":{ - "ResourceArn":{"shape":"AmazonResourceName"} + "ResourceArn":{ + "shape":"AmazonResourceName", + "location":"querystring", + "locationName":"ResourceArn" + } } }, "ListTagsForResourceResponse":{ @@ -1594,7 +1817,8 @@ "type":"structure", "required":["DashboardEnabled"], "members":{ - "DashboardEnabled":{"shape":"Enabled"} + "DashboardEnabled":{"shape":"Enabled"}, + "SubscribedDomains":{"shape":"DomainDeliverabilityTrackingOptions"} } }, "PutDeliverabilityDashboardOptionResponse":{ @@ -1724,6 +1948,7 @@ "TopicArn":{"shape":"AmazonResourceName"} } }, + "Subject":{"type":"string"}, "Tag":{ "type":"structure", "required":[ diff --git a/models/apis/pinpoint-email/2018-07-26/docs-2.json b/models/apis/pinpoint-email/2018-07-26/docs-2.json index 3e9f83e5171..e902db698d5 100644 --- a/models/apis/pinpoint-email/2018-07-26/docs-2.json +++ b/models/apis/pinpoint-email/2018-07-26/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "Amazon Pinpoint Email Service

This document contains reference information for the Amazon Pinpoint Email API, version 1.0. This document is best used in conjunction with the Amazon Pinpoint Developer Guide.

The Amazon Pinpoint Email API is available in the US East (N. Virginia), US West (Oregon), EU (Frankfurt), and EU (Ireland) Regions at the following endpoints:

", + "service": "Amazon Pinpoint Email Service

This document contains reference information for the Amazon Pinpoint Email API, version 1.0. This document is best used in conjunction with the Amazon Pinpoint Developer Guide.

The Amazon Pinpoint Email API is available in several AWS Regions and it provides an endpoint for each of these Regions. For a list of all the Regions and endpoints where the API is currently available, see AWS Regions and Endpoints in the Amazon Web Services General Reference.

In each Region, AWS maintains multiple Availability Zones. These Availability Zones are physically isolated from each other, but are united by private, low-latency, high-throughput, and highly redundant network connections. These Availability Zones enable us to provide very high levels of availability and redundancy, while also minimizing latency. To learn more about the number of Availability Zones that are available in each Region, see AWS Global Infrastructure.

", "operations": { "CreateConfigurationSet": "

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

", "CreateConfigurationSetEventDestination": "

Create an event destination. In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

A single configuration set can include more than one event destination.

", @@ -17,15 +17,17 @@ "GetConfigurationSetEventDestinations": "

Retrieve a list of event destinations that are associated with a configuration set.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

", "GetDedicatedIp": "

Get information about a dedicated IP address, including the name of the dedicated IP pool that it's associated with, as well information about the automatic warm-up process for the address.

", "GetDedicatedIps": "

List the dedicated IP addresses that are associated with your Amazon Pinpoint account.

", - "GetDeliverabilityDashboardOptions": "

Show the status of the Deliverability dashboard. When the Deliverability dashboard is enabled, you gain access to reputation metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly charge of USD$1,250.00, in addition to any other fees that you accrue by using Amazon Pinpoint. If you enable the Deliverability dashboard after the first day of a calendar month, AWS prorates the monthly charge based on how many days have elapsed in the current calendar month.

", + "GetDeliverabilityDashboardOptions": "

Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

", "GetDeliverabilityTestReport": "

Retrieve the results of a predictive inbox placement test.

", + "GetDomainDeliverabilityCampaign": "

Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

", "GetDomainStatisticsReport": "

Retrieve inbox placement and engagement rates for the domains that you use to send email.

", "GetEmailIdentity": "

Provides information about a specific identity associated with your Amazon Pinpoint account, including the identity's verification status, its DKIM authentication status, and its custom Mail-From settings.

", "ListConfigurationSets": "

List all of the configuration sets associated with your Amazon Pinpoint account in the current region.

In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

", "ListDedicatedIpPools": "

List all of the dedicated IP pools that exist in your Amazon Pinpoint account in the current AWS Region.

", "ListDeliverabilityTestReports": "

Show a list of the predictive inbox placement tests that you've performed, regardless of their statuses. For predictive inbox placement tests that are complete, you can use the GetDeliverabilityTestReport operation to view the results.

", + "ListDomainDeliverabilityCampaigns": "

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.

", "ListEmailIdentities": "

Returns a list of all of the email identities that are associated with your Amazon Pinpoint account. An identity can be either an email address or a domain. This operation returns identities that are verified as well as those that aren't.

", - "ListTagsForResource": "

Retrieve a list of the tags (keys and values) that are associated with a specific resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

", + "ListTagsForResource": "

Retrieve a list of the tags (keys and values) that are associated with a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Each tag consists of a required tag key and an optional associated tag value. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

", "PutAccountDedicatedIpWarmupAttributes": "

Enable or disable the automatic warm-up feature for dedicated IP addresses.

", "PutAccountSendingAttributes": "

Enable or disable the ability of your account to send email.

", "PutConfigurationSetDeliveryOptions": "

Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.

", @@ -34,12 +36,12 @@ "PutConfigurationSetTrackingOptions": "

Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.

", "PutDedicatedIpInPool": "

Move a dedicated IP address to an existing dedicated IP pool.

The dedicated IP address that you specify must already exist, and must be associated with your Amazon Pinpoint account.

The dedicated IP pool you specify must already exist. You can create a new pool by using the CreateDedicatedIpPool operation.

", "PutDedicatedIpWarmupAttributes": "

", - "PutDeliverabilityDashboardOption": "

Enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly charge of USD$1,250.00, in addition to any other fees that you accrue by using Amazon Pinpoint. If you enable the Deliverability dashboard after the first day of a calendar month, we prorate the monthly charge based on how many days have elapsed in the current calendar month.

", + "PutDeliverabilityDashboardOption": "

Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

", "PutEmailIdentityDkimAttributes": "

Used to enable or disable DKIM authentication for an email identity.

", "PutEmailIdentityFeedbackAttributes": "

Used to enable or disable feedback forwarding for an identity. This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

", "PutEmailIdentityMailFromAttributes": "

Used to enable or disable the custom Mail-From domain configuration for an email identity.

", "SendEmail": "

Sends an email message. You can use the Amazon Pinpoint Email API to send two types of messages:

", - "TagResource": "

Add one or more tags (keys and values) to one or more specified resources. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

", + "TagResource": "

Add one or more tags (keys and values) to a specified resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for more specific tag values. A tag value acts as a descriptor within a tag key.

", "UntagResource": "

Remove one or more tags (keys and values) from a specified resource.

", "UpdateConfigurationSetEventDestination": "

Update the configuration of an event destination for a configuration set.

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

" }, @@ -121,6 +123,13 @@ "Message$Body": "

The body of the message. You can specify an HTML version of the message, a text-only version of the message, or both.

" } }, + "CampaignId": { + "base": null, + "refs": { + "DomainDeliverabilityCampaign$CampaignId": "

The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

", + "GetDomainDeliverabilityCampaignRequest$CampaignId": "

The unique identifier for the campaign. Amazon Pinpoint automatically generates and assigns this identifier to a campaign. This value is not the same as the campaign identifier that Amazon Pinpoint assigns to campaigns that you create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint console.

" + } + }, "Charset": { "base": null, "refs": { @@ -312,6 +321,12 @@ "refs": { } }, + "DeliverabilityDashboardAccountStatus": { + "base": "

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.

", + "refs": { + "GetDeliverabilityDashboardOptionsResponse$AccountStatus": "

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.

" + } + }, "DeliverabilityTestReport": { "base": "

An object that contains metadata related to a predictive inbox placement test.

", "refs": { @@ -388,6 +403,40 @@ "DkimAttributes$Tokens": "

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 Pinpoint detects these records in the DNS configuration for your domain, the DKIM authentication process is complete. Amazon Pinpoint usually detects these records within about 72 hours of adding them to the DNS configuration for your domain.

" } }, + "Domain": { + "base": null, + "refs": { + "DomainDeliverabilityTrackingOption$Domain": "

A verified domain that’s associated with your AWS account and currently has an active Deliverability dashboard subscription.

", + "ListDomainDeliverabilityCampaignsRequest$SubscribedDomain": "

The domain to obtain deliverability data for.

" + } + }, + "DomainDeliverabilityCampaign": { + "base": "

An object that contains the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

", + "refs": { + "DomainDeliverabilityCampaignList$member": null, + "GetDomainDeliverabilityCampaignResponse$DomainDeliverabilityCampaign": "

An object that contains the deliverability data for the campaign.

" + } + }, + "DomainDeliverabilityCampaignList": { + "base": "

", + "refs": { + "ListDomainDeliverabilityCampaignsResponse$DomainDeliverabilityCampaigns": "

An array of responses, one for each campaign that used the domain to send email during the specified time range.

" + } + }, + "DomainDeliverabilityTrackingOption": { + "base": "

An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.

", + "refs": { + "DomainDeliverabilityTrackingOptions$member": null + } + }, + "DomainDeliverabilityTrackingOptions": { + "base": "

An object that contains information about the Deliverability dashboard subscription for a verified domain that you use to send email and currently has an active Deliverability dashboard subscription. If a Deliverability dashboard subscription is active for a domain, you gain access to reputation, inbox placement, and other metrics for the domain.

", + "refs": { + "GetDeliverabilityDashboardOptionsResponse$ActiveSubscribedDomains": "

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.

", + "GetDeliverabilityDashboardOptionsResponse$PendingExpirationSubscribedDomains": "

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.

", + "PutDeliverabilityDashboardOptionRequest$SubscribedDomains": "

An array of objects, one for each verified domain that you use to send email and enabled the Deliverability dashboard for.

" + } + }, "DomainIspPlacement": { "base": "

An object that contains inbox placement data for email sent from one of your email domains to a specific email provider.

", "refs": { @@ -397,7 +446,7 @@ "DomainIspPlacements": { "base": null, "refs": { - "DailyVolume$DomainIspPlacements": "

An object that contains inbox placement metrics for a specifid day in the analysis period, broken out by the recipient's email provider.

", + "DailyVolume$DomainIspPlacements": "

An object that contains inbox placement metrics for a specified day in the analysis period, broken out by the recipient's email provider.

", "OverallVolume$DomainIspPlacements": "

An object that contains inbox and junk mail placement metrics for individual email providers.

" } }, @@ -437,21 +486,34 @@ "GetAccountResponse$SendingEnabled": "

Indicates whether or not email sending is enabled for your Amazon Pinpoint account in the current AWS Region.

", "GetAccountResponse$DedicatedIpAutoWarmupEnabled": "

Indicates whether or not the automatic warm-up feature is enabled for dedicated IP addresses that are associated with your account.

", "GetAccountResponse$ProductionAccessEnabled": "

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.

", - "GetDeliverabilityDashboardOptionsResponse$DashboardEnabled": "

Indicates whether the Deliverability dashboard is enabled. If the value is true, then the dashboard is enabled.

", + "GetDeliverabilityDashboardOptionsResponse$DashboardEnabled": "

Specifies whether the Deliverability dashboard is enabled for your Amazon Pinpoint account. If this value is true, the dashboard is enabled.

", "GetEmailIdentityResponse$FeedbackForwardingStatus": "

The feedback forwarding configuration for the identity.

If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

", "GetEmailIdentityResponse$VerifiedForSendingStatus": "

Specifies whether or not the identity is verified. In Amazon Pinpoint, you can only send email from verified email addresses or domains. For more information about verifying identities, see the Amazon Pinpoint User Guide.

", "IdentityInfo$SendingEnabled": "

Indicates whether or not you can send email from the identity.

In Amazon Pinpoint, 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 Pinpoint to send email from that identity.

", + "InboxPlacementTrackingOption$Global": "

Specifies whether inbox placement data is being tracked for the domain.

", "PutAccountDedicatedIpWarmupAttributesRequest$AutoWarmupEnabled": "

Enables or disables the automatic warm-up feature for dedicated IP addresses that are associated with your Amazon Pinpoint account in the current AWS Region. Set to true to enable the automatic warm-up feature, or set to false to disable it.

", "PutAccountSendingAttributesRequest$SendingEnabled": "

Enables or disables your account's ability to send email. Set to true to enable email sending, or set to false to disable email sending.

If AWS paused your account's ability to send email, you can't use this operation to resume your account's ability to send email.

", "PutConfigurationSetReputationOptionsRequest$ReputationMetricsEnabled": "

If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.

", "PutConfigurationSetSendingOptionsRequest$SendingEnabled": "

If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.

", - "PutDeliverabilityDashboardOptionRequest$DashboardEnabled": "

Indicates whether the Deliverability dashboard is enabled. If the value is true, then the dashboard is enabled.

", + "PutDeliverabilityDashboardOptionRequest$DashboardEnabled": "

Specifies whether to enable the Deliverability dashboard for your Amazon Pinpoint account. To enable the dashboard, set this value to true.

", "PutEmailIdentityDkimAttributesRequest$SigningEnabled": "

Sets the DKIM signing configuration for the identity.

When you set this value true, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. When you set this value to false, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.

", "PutEmailIdentityFeedbackAttributesRequest$EmailForwardingEnabled": "

Sets the feedback forwarding configuration for the identity.

If the value is true, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you set this value to false, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic or another event destination. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

", "ReputationOptions$ReputationMetricsEnabled": "

If true, tracking of reputation metrics is enabled for the configuration set. If false, tracking of reputation metrics is disabled for the configuration set.

", "SendingOptions$SendingEnabled": "

If true, email sending is enabled for the configuration set. If false, email sending is disabled for the configuration set.

" } }, + "Esp": { + "base": null, + "refs": { + "Esps$member": null + } + }, + "Esps": { + "base": null, + "refs": { + "DomainDeliverabilityCampaign$Esps": "

The major email providers who handled the email message.

" + } + }, "EventDestination": { "base": "

In Amazon Pinpoint, events include message sends, deliveries, opens, clicks, bounces, and complaints. Event destinations are places that you can send information about these events to. For example, you can send event data to Amazon SNS to receive notifications when you receive bounces or complaints, or you can use Amazon Kinesis Data Firehose to stream data to Amazon S3 for long-term storage.

", "refs": { @@ -560,7 +622,7 @@ } }, "GetDeliverabilityDashboardOptionsRequest": { - "base": "

A request to retrieve the status of the Deliverability dashboard for your account. When the Deliverability dashboard is enabled, you gain access to reputation metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly charge of USD$1,250.00, in addition to any other fees that you accrue by using Amazon Pinpoint. If you enable the Deliverability dashboard after the first day of a calendar month, AWS prorates the monthly charge based on how many days have elapsed in the current calendar month.

", + "base": "

Retrieve information about the status of the Deliverability dashboard for your Amazon Pinpoint account. When the Deliverability dashboard is enabled, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

", "refs": { } }, @@ -579,6 +641,16 @@ "refs": { } }, + "GetDomainDeliverabilityCampaignRequest": { + "base": "

Retrieve all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

", + "refs": { + } + }, + "GetDomainDeliverabilityCampaignResponse": { + "base": "

An object that contains all the deliverability data for a specific campaign. This data is available for a campaign only if the campaign sent email by using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption operation).

", + "refs": { + } + }, "GetDomainStatisticsReportRequest": { "base": "

A request to obtain deliverability metrics for a domain.

", "refs": { @@ -604,6 +676,7 @@ "refs": { "CreateEmailIdentityRequest$EmailIdentity": "

The email address or domain that you want to verify.

", "DeleteEmailIdentityRequest$EmailIdentity": "

The identity (that is, the email address or domain) that you want to delete from your Amazon Pinpoint account.

", + "DomainDeliverabilityCampaign$FromAddress": "

The verified email address that the email message was sent from.

", "GetDomainStatisticsReportRequest$Domain": "

The domain that you want to obtain deliverability metrics for.

", "GetEmailIdentityRequest$EmailIdentity": "

The email identity that you want to retrieve details for.

", "IdentityInfo$IdentityName": "

The address or domain of the identity.

", @@ -632,22 +705,48 @@ "IdentityInfo$IdentityType": "

The email identity type. The identity type can be one of the following:

" } }, + "ImageUrl": { + "base": null, + "refs": { + "DomainDeliverabilityCampaign$ImageUrl": "

The URL of an image that contains a snapshot of the email message that was sent.

" + } + }, + "InboxPlacementTrackingOption": { + "base": "

An object that contains information about the inbox placement data settings for a verified domain that’s associated with your AWS account. This data is available only if you enabled the Deliverability dashboard for the domain (PutDeliverabilityDashboardOption operation).

", + "refs": { + "DomainDeliverabilityTrackingOption$InboxPlacementTrackingOption": "

An object that contains information about the inbox placement data settings for the domain.

" + } + }, "Ip": { "base": "

A dedicated IP address that is associated with your Amazon Pinpoint account.

", "refs": { "DedicatedIp$Ip": "

An IP address that is reserved for use by your Amazon Pinpoint account.

", "GetDedicatedIpRequest$Ip": "

The IP address that you want to obtain more information about. The value you specify has to be a dedicated IP address that's assocaited with your Amazon Pinpoint account.

", + "IpList$member": null, "PutDedicatedIpInPoolRequest$Ip": "

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 Amazon Pinpoint account.

", "PutDedicatedIpWarmupAttributesRequest$Ip": "

The dedicated IP address that you want to update the warm-up attributes for.

" } }, + "IpList": { + "base": null, + "refs": { + "DomainDeliverabilityCampaign$SendingIps": "

The IP addresses that were used to send the email message.

" + } + }, "IspName": { "base": "

The name of an email provider.

", "refs": { "DomainIspPlacement$IspName": "

The name of the email provider that the inbox placement data applies to.

", + "IspNameList$member": null, "IspPlacement$IspName": "

The name of the email provider that the inbox placement data applies to.

" } }, + "IspNameList": { + "base": null, + "refs": { + "InboxPlacementTrackingOption$TrackedIsps": "

An array of strings, one for each major email provider that the inbox placement data applies to.

" + } + }, "IspPlacement": { "base": "

An object that describes how email sent during the predictive inbox placement test was handled by a certain email provider.

", "refs": { @@ -708,6 +807,16 @@ "refs": { } }, + "ListDomainDeliverabilityCampaignsRequest": { + "base": "

Retrieve deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.

", + "refs": { + } + }, + "ListDomainDeliverabilityCampaignsResponse": { + "base": "

An array of objects that provide deliverability data for all the campaigns that used a specific domain to send email during a specified time range. This data is available for a domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption operation) for the domain.

", + "refs": { + } + }, "ListEmailIdentitiesRequest": { "base": "

A request to list all of the email identities associated with your Amazon Pinpoint account. This list includes identities that you've already verified, identities that are unverified, and identities that were verified in the past, but are no longer verified.

", "refs": { @@ -771,6 +880,7 @@ "ListConfigurationSetsRequest$PageSize": "

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.

", "ListDedicatedIpPoolsRequest$PageSize": "

The number of results to show in a single call to ListDedicatedIpPools. 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.

", "ListDeliverabilityTestReportsRequest$PageSize": "

The number of results to show in a single call to ListDeliverabilityTestReports. 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 0, and can be no more than 1000.

", + "ListDomainDeliverabilityCampaignsRequest$PageSize": "

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.

", "ListEmailIdentitiesRequest$PageSize": "

The number of results to show in a single call to ListEmailIdentities. 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 0, and can be no more than 1000.

" } }, @@ -838,6 +948,8 @@ "ListDedicatedIpPoolsResponse$NextToken": "

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.

", "ListDeliverabilityTestReportsRequest$NextToken": "

A token returned from a previous call to ListDeliverabilityTestReports to indicate the position in the list of predictive inbox placement tests.

", "ListDeliverabilityTestReportsResponse$NextToken": "

A token that indicates that there are additional predictive inbox placement tests to list. To view additional predictive inbox placement tests, issue another request to ListDeliverabilityTestReports, and pass this token in the NextToken parameter.

", + "ListDomainDeliverabilityCampaignsRequest$NextToken": "

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.

", + "ListDomainDeliverabilityCampaignsResponse$NextToken": "

A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns operation. This token indicates the position of the campaign in the list of campaigns.

", "ListEmailIdentitiesRequest$NextToken": "

A token returned from a previous call to ListEmailIdentities to indicate the position in the list of identities.

", "ListEmailIdentitiesResponse$NextToken": "

A token that indicates that there are additional configuration sets to list. To view additional configuration sets, issue another request to ListEmailIdentities, and pass this token in the NextToken parameter.

" } @@ -862,6 +974,9 @@ "Percentage": { "base": "

An object that contains information about inbox placement percentages.

", "refs": { + "DomainDeliverabilityCampaign$ReadRate": "

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.

", + "DomainDeliverabilityCampaign$DeleteRate": "

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.

", + "DomainDeliverabilityCampaign$ReadDeleteRate": "

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.

", "DomainIspPlacement$InboxPercentage": "

The percentage of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.

", "DomainIspPlacement$SpamPercentage": "

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.

", "OverallVolume$ReadRatePercent": "

The percentage of emails that were sent from the domain that were read by their recipients.

", @@ -986,7 +1101,7 @@ } }, "PutDeliverabilityDashboardOptionRequest": { - "base": "

A request to enable or disable the Deliverability dashboard. When you enable the Deliverability dashboard, you gain access to reputation metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly charge of USD$1,250.00, in addition to any other fees that you accrue by using Amazon Pinpoint. If you enable the Deliverability dashboard after the first day of a calendar month, we prorate the monthly charge based on how many days have elapsed in the current calendar month.

", + "base": "

Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. When you enable the Deliverability dashboard, you gain access to reputation, deliverability, and other metrics for the domains that you use to send email using Amazon Pinpoint. You also gain the ability to perform predictive inbox placement tests.

When you use the Deliverability dashboard, you pay a monthly subscription charge, in addition to any other fees that you accrue by using Amazon Pinpoint. For more information about the features and cost of a Deliverability dashboard subscription, see Amazon Pinpoint Pricing.

", "refs": { } }, @@ -1112,8 +1227,14 @@ "EventDestinationDefinition$SnsDestination": "

An object that defines an Amazon SNS destination for email events. You can use Amazon SNS to send notification when certain email events occur.

" } }, + "Subject": { + "base": null, + "refs": { + "DomainDeliverabilityCampaign$Subject": "

The subject line, or title, of the email message.

" + } + }, "Tag": { - "base": "

An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. For example, if you have two versions of an Amazon Pinpoint project, one for internal testing and another for external use, you might assign a Stack tag key to both projects. The value of the Stack tag key might be Test for one project and Production for the other project.

A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:

", + "base": "

An object that defines the tags that are associated with a resource. A tag is a label that you optionally define and associate with a resource in Amazon Pinpoint. Tags can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. A resource can have as many as 50 tags.

Each tag consists of a required tag key and an associated tag value, both of which you define. A tag key is a general label that acts as a category for a more specific tag value. A tag value acts as a descriptor within a tag key. A tag key can contain as many as 128 characters. A tag value can contain as many as 256 characters. The characters can be Unicode letters, digits, white space, or one of the following symbols: _ . : / = + -. The following additional restrictions apply to tags:

", "refs": { "TagList$member": null } @@ -1134,10 +1255,13 @@ "TagList": { "base": null, "refs": { - "CreateConfigurationSetRequest$Tags": "

An object that defines the tags (keys and values) that you want to associate with the configuration set.

", + "CreateConfigurationSetRequest$Tags": "

An array of objects that define the tags (keys and values) that you want to associate with the configuration set.

", "CreateDedicatedIpPoolRequest$Tags": "

An object that defines the tags (keys and values) that you want to associate with the pool.

", - "CreateDeliverabilityTestReportRequest$Tags": "

An object that defines the tags (keys and values) that you want to associate with the predictive inbox placement test.

", - "CreateEmailIdentityRequest$Tags": "

An object that defines the tags (keys and values) that you want to associate with the email identity.

", + "CreateDeliverabilityTestReportRequest$Tags": "

An array of objects that define the tags (keys and values) that you want to associate with the predictive inbox placement test.

", + "CreateEmailIdentityRequest$Tags": "

An array of objects that define the tags (keys and values) that you want to associate with the email identity.

", + "GetConfigurationSetResponse$Tags": "

An array of objects that define the tags (keys and values) that are associated with the configuration set.

", + "GetDeliverabilityTestReportResponse$Tags": "

An array of objects that define the tags (keys and values) that are associated with the predictive inbox placement test.

", + "GetEmailIdentityResponse$Tags": "

An array of objects that define the tags (keys and values) that are associated with the email identity.

", "ListTagsForResourceResponse$Tags": "

An array that lists all the tags that are associated with the resource. Each tag consists of a required tag key (Key) and an associated tag value (Value)

", "TagResourceRequest$Tags": "

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 characters.

" } @@ -1164,8 +1288,14 @@ "BlacklistEntry$ListingTime": "

The time when the blacklisting event occurred, shown in Unix time format.

", "DailyVolume$StartDate": "

The date that the DailyVolume metrics apply to, in Unix time.

", "DeliverabilityTestReport$CreateDate": "

The date and time when the predictive inbox placement test was created, in Unix time format.

", + "DomainDeliverabilityCampaign$FirstSeenDateTime": "

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.

", + "DomainDeliverabilityCampaign$LastSeenDateTime": "

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.

", + "DomainDeliverabilityTrackingOption$SubscriptionStartDate": "

The date, in Unix time format, when you enabled the Deliverability dashboard for the domain.

", + "GetDeliverabilityDashboardOptionsResponse$SubscriptionExpiryDate": "

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.

", "GetDomainStatisticsReportRequest$StartDate": "

The first day (in Unix time) that you want to obtain domain deliverability metrics for.

", - "GetDomainStatisticsReportRequest$EndDate": "

The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate that you specify has to be less than or equal to 30 days after the StartDate.

" + "GetDomainStatisticsReportRequest$EndDate": "

The last day (in Unix time) that you want to obtain domain deliverability metrics for. The EndDate that you specify has to be less than or equal to 30 days after the StartDate.

", + "ListDomainDeliverabilityCampaignsRequest$StartDate": "

The first day, in Unix time format, that you want to obtain deliverability data for.

", + "ListDomainDeliverabilityCampaignsRequest$EndDate": "

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.

" } }, "TooManyRequestsException": { @@ -1203,6 +1333,9 @@ "Volume": { "base": "

An object that contains information about inbox placement volume.

", "refs": { + "DomainDeliverabilityCampaign$InboxCount": "

The number of email messages that were delivered to recipients’ inboxes.

", + "DomainDeliverabilityCampaign$SpamCount": "

The number of email messages that were delivered to recipients' spam or junk mail folders.

", + "DomainDeliverabilityCampaign$ProjectedVolume": "

The projected number of recipients that the email message was sent to.

", "DomainIspPlacement$InboxRawCount": "

The total number of messages that were sent from the selected domain to the specified email provider that arrived in recipients' inboxes.

", "DomainIspPlacement$SpamRawCount": "

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.

", "VolumeStatistics$InboxRawCount": "

The total number of emails that arrived in recipients' inboxes.

", diff --git a/models/apis/pinpoint-email/2018-07-26/paginators-1.json b/models/apis/pinpoint-email/2018-07-26/paginators-1.json index 447d3ec5b65..8a17fd2e79a 100644 --- a/models/apis/pinpoint-email/2018-07-26/paginators-1.json +++ b/models/apis/pinpoint-email/2018-07-26/paginators-1.json @@ -20,6 +20,11 @@ "output_token": "NextToken", "limit_key": "PageSize" }, + "ListDomainDeliverabilityCampaigns": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "PageSize" + }, "ListEmailIdentities": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/models/apis/pinpoint-email/2018-07-26/smoke.json b/models/apis/pinpoint-email/2018-07-26/smoke.json new file mode 100644 index 00000000000..c7aa6c5f27e --- /dev/null +++ b/models/apis/pinpoint-email/2018-07-26/smoke.json @@ -0,0 +1,18 @@ +{ + "version": 1, + "defaultRegion": "us-west-2", + "testCases": [ + { + "operationName": "ListConfigurationSets", + "input": {}, + "errorExpectedFromService": false + }, + { + "operationName": "PutConfigurationSetTrackingOptions", + "input": { + "ConfigurationSetName": "config-set-name-not-exists" + }, + "errorExpectedFromService": true + } + ] +} diff --git a/models/apis/rds/2014-10-31/api-2.json b/models/apis/rds/2014-10-31/api-2.json index 50bc3a5482a..f95ca35e531 100644 --- a/models/apis/rds/2014-10-31/api-2.json +++ b/models/apis/rds/2014-10-31/api-2.json @@ -3052,7 +3052,8 @@ "SupportsLogExportsToCloudwatchLogs":{"shape":"Boolean"}, "SupportsReadReplica":{"shape":"Boolean"}, "SupportedEngineModes":{"shape":"EngineModeList"}, - "SupportedFeatureNames":{"shape":"FeatureNameList"} + "SupportedFeatureNames":{"shape":"FeatureNameList"}, + "Status":{"shape":"String"} } }, "DBEngineVersionList":{ @@ -3919,7 +3920,8 @@ "Marker":{"shape":"String"}, "DefaultOnly":{"shape":"Boolean"}, "ListSupportedCharacterSets":{"shape":"BooleanOptional"}, - "ListSupportedTimezones":{"shape":"BooleanOptional"} + "ListSupportedTimezones":{"shape":"BooleanOptional"}, + "IncludeAll":{"shape":"BooleanOptional"} } }, "DescribeDBInstanceAutomatedBackupsMessage":{ diff --git a/models/apis/rds/2014-10-31/docs-2.json b/models/apis/rds/2014-10-31/docs-2.json index 5b7b551f014..cc07dbfd300 100644 --- a/models/apis/rds/2014-10-31/docs-2.json +++ b/models/apis/rds/2014-10-31/docs-2.json @@ -31,7 +31,7 @@ "DeleteDBClusterEndpoint": "

Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

", "DeleteDBClusterParameterGroup": "

Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", "DeleteDBClusterSnapshot": "

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The DB cluster snapshot must be in the available state to be deleted.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

This action only applies to Aurora DB clusters.

", - "DeleteDBInstance": "

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when you skip creation of the final snapshot with the SkipFinalSnapshot parameter.

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:

To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

", + "DeleteDBInstance": "

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by DeleteDBInstance are not deleted.

If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB snapshot is created. The API action DescribeDBInstance is used to monitor the status of this operation. The action can't be canceled or reverted once submitted.

Note that when a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:

To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to promote the DB cluster so it's no longer a Read Replica. After the promotion completes, then call the DeleteDBInstance API action to delete the final instance in the DB cluster.

", "DeleteDBInstanceAutomatedBackup": "

Deletes automated backups based on the source instance's DbiResourceId value or the restorable instance's resource ID.

", "DeleteDBParameterGroup": "

Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

", "DeleteDBSecurityGroup": "

Deletes a DB security group.

The specified DB security group must not be associated with any DB instances.

", @@ -119,7 +119,7 @@ } }, "AccountQuota": { - "base": "

Describes a quota for an AWS account.

The following are account quotas:

For more information, see Limits in the Amazon RDS User Guide and Limits in the Amazon Aurora User Guide.

", + "base": "

Describes a quota for an AWS account, for example, the number of DB instances allowed.

", "refs": { "AccountQuotaList$member": null } @@ -258,11 +258,11 @@ "refs": { "DBCluster$MultiAZ": "

Specifies whether the DB cluster has instances in multiple Availability Zones.

", "DBCluster$StorageEncrypted": "

Specifies whether the DB cluster is encrypted.

", - "DBCluster$IAMDatabaseAuthenticationEnabled": "

A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

", - "DBCluster$DeletionProtection": "

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

", - "DBCluster$HttpEndpointEnabled": "

HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

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 about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

", + "DBCluster$IAMDatabaseAuthenticationEnabled": "

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

", + "DBCluster$DeletionProtection": "

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.

", + "DBCluster$HttpEndpointEnabled": "

HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster is enabled and false otherwise.

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 about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

", "DBCluster$CopyTagsToSnapshot": "

Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

", - "DBClusterMember$IsClusterWriter": "

A value that indicates whehter the cluster member is the primary instance for the DB cluster.

", + "DBClusterMember$IsClusterWriter": "

Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

", "DBClusterSnapshot$StorageEncrypted": "

Specifies whether the DB cluster snapshot is encrypted.

", "DBClusterSnapshot$IAMDatabaseAuthenticationEnabled": "

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

", "DBEngineVersion$SupportsLogExportsToCloudwatchLogs": "

A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.

", @@ -273,26 +273,26 @@ "DBInstance$StorageEncrypted": "

Specifies whether the DB instance is encrypted.

", "DBInstance$CopyTagsToSnapshot": "

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.

", "DBInstance$IAMDatabaseAuthenticationEnabled": "

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

", - "DBInstance$DeletionProtection": "

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.

", + "DBInstance$DeletionProtection": "

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when this value is set to true. For more information, see Deleting a DB Instance.

", "DBInstanceAutomatedBackup$Encrypted": "

Specifies whether the automated backup is encrypted.

", "DBInstanceAutomatedBackup$IAMDatabaseAuthenticationEnabled": "

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

", "DBInstanceStatusInfo$Normal": "

Boolean value that is true if the instance is operating normally, or false if the instance is in an error state.

", "DBSnapshot$Encrypted": "

Specifies whether the DB snapshot is encrypted.

", "DBSnapshot$IAMDatabaseAuthenticationEnabled": "

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

", - "DeleteDBClusterMessage$SkipFinalSnapshot": "

A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip is not specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip is not specified, and the DB cluster snapshot is created. By default, this parameter is disabled.

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

", - "DeleteDBInstanceMessage$SkipFinalSnapshot": "

A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted. If skip is specified, no DB snapshot is created. If skip is not specified, a DB snapshot is created before the DB instance is deleted. By default, skip is not specified, and the DB snapshot is created.

Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when skip is specified.

Specify skip when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if skip is not specified.

", - "DescribeDBClusterSnapshotsMessage$IncludeShared": "

A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.

", - "DescribeDBClusterSnapshotsMessage$IncludePublic": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

", - "DescribeDBEngineVersionsMessage$DefaultOnly": "

A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

", - "DescribeDBSnapshotsMessage$IncludeShared": "

A value that indicates whether to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been given permission to copy or restore. By default, these snapshots are not included.

You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

", - "DescribeDBSnapshotsMessage$IncludePublic": "

A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account. By default, the public snapshots are not included.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

", + "DeleteDBClusterMessage$SkipFinalSnapshot": "

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

", + "DeleteDBInstanceMessage$SkipFinalSnapshot": "

A value that indicates whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted.

When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, you can only delete it when the SkipFinalSnapshot parameter is set to true.

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

", + "DescribeDBClusterSnapshotsMessage$IncludeShared": "

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 manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.

", + "DescribeDBClusterSnapshotsMessage$IncludePublic": "

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.

", + "DescribeDBEngineVersionsMessage$DefaultOnly": "

Indicates that only the default version of the specified engine or engine and major version combination is returned.

", + "DescribeDBSnapshotsMessage$IncludeShared": "

True to include shared manual DB 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 manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.

", + "DescribeDBSnapshotsMessage$IncludePublic": "

True to include manual DB snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false.

You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.

", "DownloadDBLogFilePortionDetails$AdditionalDataPending": "

Boolean value that if true, indicates there is more data to be downloaded.

", "EventSubscription$Enabled": "

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

", "GlobalClusterMember$IsWriter": "

Specifies whether the Aurora cluster is the primary cluster (that is, has read-write capability) for the Aurora global database with which it is associated.

", - "ModifyDBClusterMessage$ApplyImmediately": "

A value that indicates 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 disabled, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

By default, this parameter is disabled.

", - "ModifyDBInstanceMessage$ApplyImmediately": "

A value that indicates 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. By default, this parameter is disabled.

If this parameter is disabled, 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. Review the table of parameters in Modifying a DB Instance in the Amazon RDS User Guide. to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.

", - "ModifyDBInstanceMessage$AllowMajorVersionUpgrade": "

A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

", - "ModifyOptionGroupMessage$ApplyImmediately": "

A value that indicates whether to apply the change immediately or during the next maintenance window for each instance associated with the option group.

", + "ModifyDBClusterMessage$ApplyImmediately": "

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 EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to the EnableIAMDatabaseAuthentication, MasterUserPassword, and NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

", + "ModifyDBInstanceMessage$ApplyImmediately": "

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. Review the table of parameters in Modifying a DB Instance and Using the Apply Immediately Parameter in the Amazon RDS User Guide. to see the impact that setting ApplyImmediately to true or false has for each modified parameter and to determine when the changes are applied.

Default: false

", + "ModifyDBInstanceMessage$AllowMajorVersionUpgrade": "

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.

Constraints: This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

", + "ModifyOptionGroupMessage$ApplyImmediately": "

Indicates whether the changes should be applied immediately, or during the next maintenance window for each instance associated with the option group.

", "Option$Persistent": "

Indicate if this option is persistent.

", "Option$Permanent": "

Indicate if this option is permanent.

", "OptionGroup$AllowsVpcAndNonVpcInstanceMemberships": "

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.

", @@ -317,104 +317,105 @@ "Parameter$IsModifiable": "

Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

", "ReservedDBInstance$MultiAZ": "

Indicates if the reservation applies to Multi-AZ deployments.

", "ReservedDBInstancesOffering$MultiAZ": "

Indicates if the offering applies to Multi-AZ deployments.

", - "ResetDBClusterParameterGroupMessage$ResetAllParameters": "

A value that indicates whether to reset all parameters in the DB cluster parameter group to their default values. You can't use this parameter if there is a list of parameter names specified for the Parameters parameter.

", - "ResetDBParameterGroupMessage$ResetAllParameters": "

A value that indicates whether to reset all parameters in the DB parameter group to default values. By default, all parameters in the DB parameter group are reset to default values.

", - "RestoreDBClusterToPointInTimeMessage$UseLatestRestorableTime": "

A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time.

Constraints: Can't be specified if RestoreToTime parameter is provided.

", - "RestoreDBInstanceToPointInTimeMessage$UseLatestRestorableTime": "

A value that indicates whether the DB instance is restored from the latest backup time. By default, the DB instance is not restored from the latest backup time.

Constraints: Can't be specified if the RestoreTime parameter is provided.

", - "UpgradeTarget$AutoUpgrade": "

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

", + "ResetDBClusterParameterGroupMessage$ResetAllParameters": "

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.

", + "ResetDBParameterGroupMessage$ResetAllParameters": "

Specifies whether (true) or not (false) to reset all parameters in the DB parameter group to default values.

Default: true

", + "RestoreDBClusterToPointInTimeMessage$UseLatestRestorableTime": "

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Can't be specified if RestoreToTime parameter is provided.

", + "RestoreDBInstanceToPointInTimeMessage$UseLatestRestorableTime": "

Specifies whether (true) or not (false) the DB instance is restored from the latest backup time.

Default: false

Constraints: Can't be specified if RestoreTime parameter is provided.

", + "UpgradeTarget$AutoUpgrade": "

A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.

", "UpgradeTarget$IsMajorVersionUpgrade": "

A value that indicates whether a database engine is upgraded to a major version.

" } }, "BooleanOptional": { "base": null, "refs": { - "BacktrackDBClusterMessage$Force": "

A value that indicates whether to force the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

", - "BacktrackDBClusterMessage$UseEarliestTimeOnPointInTimeUnavailable": "

A value that indicates whether to backtrack the DB cluster to the earliest possible backtrack time when BacktrackTo is set to a timestamp earlier than the earliest backtrack time. When this parameter is disabled and BacktrackTo is set to a timestamp earlier than the earliest backtrack time, an error occurs.

", - "CopyDBClusterSnapshotMessage$CopyTags": "

A value that indicates whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.

", - "CopyDBSnapshotMessage$CopyTags": "

A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.

", - "CreateDBClusterMessage$StorageEncrypted": "

A value that indicates whether the DB cluster is encrypted.

", - "CreateDBClusterMessage$EnableIAMDatabaseAuthentication": "

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

", - "CreateDBClusterMessage$DeletionProtection": "

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.

", - "CreateDBClusterMessage$CopyTagsToSnapshot": "

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

", - "CreateDBInstanceMessage$MultiAZ": "

A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.

", - "CreateDBInstanceMessage$AutoMinorVersionUpgrade": "

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 applied automatically.

", - "CreateDBInstanceMessage$PubliclyAccessible": "

A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName is not specified, and PubliclyAccessible is not specified, the following applies:

If DBSubnetGroupName is specified, and PubliclyAccessible is not specified, the following applies:

", - "CreateDBInstanceMessage$StorageEncrypted": "

A value that indicates whether the DB instance is encrypted. By default, it is not encrypted.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster.

", - "CreateDBInstanceMessage$CopyTagsToSnapshot": "

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

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.

", - "CreateDBInstanceMessage$EnableIAMDatabaseAuthentication": "

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

You can enable IAM database authentication for the following database engines:

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.

MySQL

", - "CreateDBInstanceMessage$EnablePerformanceInsights": "

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

", - "CreateDBInstanceMessage$DeletionProtection": "

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 Instance.

", - "CreateDBInstanceReadReplicaMessage$MultiAZ": "

A value that indicates whether the Read Replica is in a Multi-AZ deployment.

You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.

", - "CreateDBInstanceReadReplicaMessage$AutoMinorVersionUpgrade": "

A value that indicates whether minor engine upgrades are applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB instance

", - "CreateDBInstanceReadReplicaMessage$PubliclyAccessible": "

A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

", - "CreateDBInstanceReadReplicaMessage$CopyTagsToSnapshot": "

A value that indicates whether to copy all tags from the Read Replica to snapshots of the Read Replica. By default, tags are not copied.

", - "CreateDBInstanceReadReplicaMessage$EnableIAMDatabaseAuthentication": "

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

You can enable IAM database authentication for the following database engines

", - "CreateDBInstanceReadReplicaMessage$EnablePerformanceInsights": "

A value that indicates whether to enable Performance Insights for the Read Replica.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

", - "CreateDBInstanceReadReplicaMessage$UseDefaultProcessorFeatures": "

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

", - "CreateDBInstanceReadReplicaMessage$DeletionProtection": "

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 Instance.

", - "CreateEventSubscriptionMessage$Enabled": "

A value that indicates whether to activate the subscription. If the event notification subscription is not activated, the subscription is created but not active.

", - "CreateGlobalClusterMessage$DeletionProtection": "

The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.

", + "BacktrackDBClusterMessage$Force": "

A value that, if specified, forces the DB cluster to backtrack when binary logging is enabled. Otherwise, an error occurs when binary logging is enabled.

", + "BacktrackDBClusterMessage$UseEarliestTimeOnPointInTimeUnavailable": "

If BacktrackTo is set to a timestamp earlier than the earliest backtrack time, this value backtracks the DB cluster to the earliest possible backtrack time. Otherwise, an error occurs.

", + "CopyDBClusterSnapshotMessage$CopyTags": "

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

", + "CopyDBSnapshotMessage$CopyTags": "

True to copy all tags from the source DB snapshot to the target DB snapshot, and otherwise false. The default is false.

", + "CreateDBClusterMessage$StorageEncrypted": "

Specifies whether the DB cluster is encrypted.

", + "CreateDBClusterMessage$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

", + "CreateDBClusterMessage$DeletionProtection": "

Indicates whether the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

", + "CreateDBClusterMessage$CopyTagsToSnapshot": "

True to copy all tags from the DB cluster to snapshots of the DB cluster, and otherwise false. The default is false.

", + "CreateDBInstanceMessage$MultiAZ": "

A value that specifies whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.

", + "CreateDBInstanceMessage$AutoMinorVersionUpgrade": "

Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

Default: true

", + "CreateDBInstanceMessage$PubliclyAccessible": "

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.

Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

If DBSubnetGroupName is not specified, and PubliclyAccessible is not specified, the following applies:

If DBSubnetGroupName is specified, and PubliclyAccessible is not specified, the following applies:

", + "CreateDBInstanceMessage$StorageEncrypted": "

Specifies whether the DB instance is encrypted.

Amazon Aurora

Not applicable. The encryption for DB instances is managed by the DB cluster.

Default: false

", + "CreateDBInstanceMessage$CopyTagsToSnapshot": "

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

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.

", + "CreateDBInstanceMessage$EnableIAMDatabaseAuthentication": "

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:

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.

MySQL

Default: false

", + "CreateDBInstanceMessage$EnablePerformanceInsights": "

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

", + "CreateDBInstanceMessage$DeletionProtection": "

Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

", + "CreateDBInstanceReadReplicaMessage$MultiAZ": "

Specifies whether the Read Replica is in a Multi-AZ deployment.

You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your Read Replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.

", + "CreateDBInstanceReadReplicaMessage$AutoMinorVersionUpgrade": "

Indicates that minor engine upgrades are applied automatically to the Read Replica during the maintenance window.

Default: Inherits from the source DB instance

", + "CreateDBInstanceReadReplicaMessage$PubliclyAccessible": "

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. For more information, see CreateDBInstance.

", + "CreateDBInstanceReadReplicaMessage$CopyTagsToSnapshot": "

True to copy all tags from the Read Replica to snapshots of the Read Replica, and otherwise false. The default is false.

", + "CreateDBInstanceReadReplicaMessage$EnableIAMDatabaseAuthentication": "

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

Default: false

", + "CreateDBInstanceReadReplicaMessage$EnablePerformanceInsights": "

True to enable Performance Insights for the Read Replica, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.

", + "CreateDBInstanceReadReplicaMessage$UseDefaultProcessorFeatures": "

A value that specifies that the DB instance class of the DB instance uses its default processor features.

", + "CreateDBInstanceReadReplicaMessage$DeletionProtection": "

Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

", + "CreateEventSubscriptionMessage$Enabled": "

A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.

", + "CreateGlobalClusterMessage$DeletionProtection": "

The deletion protection setting for the new global database. The global database can't be deleted when this value is set to true.

", "CreateGlobalClusterMessage$StorageEncrypted": "

The storage encryption setting for the new global database cluster.

", "DBInstance$PerformanceInsightsEnabled": "

True if Performance Insights is enabled for the DB instance, and otherwise false.

", - "DeleteDBInstanceMessage$DeleteAutomatedBackups": "

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

", - "DescribeDBEngineVersionsMessage$ListSupportedCharacterSets": "

A value that indicates whether to list the supported character sets for each engine version.

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

", - "DescribeDBEngineVersionsMessage$ListSupportedTimezones": "

A value that indicates whether to list the supported time zones for each engine version.

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

", - "DescribeOrderableDBInstanceOptionsMessage$Vpc": "

A value that indicates whether to show only VPC or non-VPC offerings.

", - "DescribeReservedDBInstancesMessage$MultiAZ": "

A value that indicates whether to show only those reservations that support Multi-AZ.

", - "DescribeReservedDBInstancesOfferingsMessage$MultiAZ": "

A value that indicates whether to show only those reservations that support Multi-AZ.

", + "DeleteDBInstanceMessage$DeleteAutomatedBackups": "

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. This parameter defaults to true.

", + "DescribeDBEngineVersionsMessage$ListSupportedCharacterSets": "

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.

", + "DescribeDBEngineVersionsMessage$ListSupportedTimezones": "

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.

", + "DescribeDBEngineVersionsMessage$IncludeAll": "

Whether to include non-available engine versions in the list. The default is to list only available engine versions.

", + "DescribeOrderableDBInstanceOptionsMessage$Vpc": "

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

", + "DescribeReservedDBInstancesMessage$MultiAZ": "

The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.

", + "DescribeReservedDBInstancesOfferingsMessage$MultiAZ": "

The Multi-AZ filter value. Specify this parameter to show only the available offerings matching the specified Multi-AZ parameter.

", "GlobalCluster$StorageEncrypted": "

The storage encryption setting for the global database cluster.

", "GlobalCluster$DeletionProtection": "

The deletion protection setting for the new global database cluster.

", - "ModifyDBClusterMessage$EnableIAMDatabaseAuthentication": "

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

", - "ModifyDBClusterMessage$DeletionProtection": "

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.

", + "ModifyDBClusterMessage$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

", + "ModifyDBClusterMessage$DeletionProtection": "

Indicates if the DB cluster has deletion protection enabled. The database can't be deleted when this value is set to true.

", "ModifyDBClusterMessage$EnableHttpEndpoint": "

HTTP endpoint functionality is in beta for Aurora Serverless and is subject to change.

A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. By default, the HTTP endpoint is disabled.

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 about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

", - "ModifyDBClusterMessage$CopyTagsToSnapshot": "

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them.

", - "ModifyDBInstanceMessage$MultiAZ": "

A value that indicates whether 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 enabled for this request.

", - "ModifyDBInstanceMessage$AutoMinorVersionUpgrade": "

A value that indicates whether 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 results if this parameter is enabled during the maintenance window, and a newer minor version is available, and RDS has enabled auto patching for that engine version.

", - "ModifyDBInstanceMessage$CopyTagsToSnapshot": "

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.

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 ModifyDBCluster.

", - "ModifyDBInstanceMessage$PubliclyAccessible": "

A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address.

PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.

Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

", - "ModifyDBInstanceMessage$EnableIAMDatabaseAuthentication": "

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

You can enable IAM database authentication for the following database engines

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.

MySQL

", - "ModifyDBInstanceMessage$EnablePerformanceInsights": "

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

", - "ModifyDBInstanceMessage$UseDefaultProcessorFeatures": "

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

", - "ModifyDBInstanceMessage$DeletionProtection": "

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 Instance.

", - "ModifyEventSubscriptionMessage$Enabled": "

A value that indicates whether to activate the subscription.

", - "ModifyGlobalClusterMessage$DeletionProtection": "

Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when deletion protection is enabled.

", + "ModifyDBClusterMessage$CopyTagsToSnapshot": "

True to copy all tags from the DB cluster to snapshots of the DB cluster, and otherwise false. The default is false.

", + "ModifyDBInstanceMessage$MultiAZ": "

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.

", + "ModifyDBInstanceMessage$AutoMinorVersionUpgrade": "

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 RDS has enabled auto patching for that engine version.

", + "ModifyDBInstanceMessage$CopyTagsToSnapshot": "

True to copy all tags from the DB instance to snapshots of the DB instance, and otherwise false. The default is false.

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 ModifyDBCluster.

", + "ModifyDBInstanceMessage$PubliclyAccessible": "

Boolean value that indicates if the DB instance has a publicly resolvable DNS name. Set to True to make the DB instance Internet-facing with a publicly resolvable DNS name, which resolves to a public IP address. Set to False to make the DB instance internal with a DNS name that resolves to a private IP address.

PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be true in order for it to be publicly accessible.

Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.

Default: false

", + "ModifyDBInstanceMessage$EnableIAMDatabaseAuthentication": "

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

Amazon Aurora

Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. For more information, see ModifyDBCluster.

MySQL

Default: false

", + "ModifyDBInstanceMessage$EnablePerformanceInsights": "

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

", + "ModifyDBInstanceMessage$UseDefaultProcessorFeatures": "

A value that specifies that the DB instance class of the DB instance uses its default processor features.

", + "ModifyDBInstanceMessage$DeletionProtection": "

Indicates if the DB instance has deletion protection enabled. The database can't be deleted when this value is set to true. For more information, see Deleting a DB Instance.

", + "ModifyEventSubscriptionMessage$Enabled": "

A Boolean value; set to true to activate the subscription.

", + "ModifyGlobalClusterMessage$DeletionProtection": "

Indicates if the global database cluster has deletion protection enabled. The global database cluster can't be deleted when this value is set to true.

", "OptionGroupOption$SupportsOptionVersionDowngrade": "

If true, you can change the option to an earlier version of the option. This only applies to options that have different versions available.

", "PendingModifiedValues$MultiAZ": "

Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment.

", - "RebootDBInstanceMessage$ForceFailover": "

A value that indicates whether the reboot is conducted through a Multi-AZ failover.

Constraint: You can't enable force failover if the instance is not configured for Multi-AZ.

", - "RestoreDBClusterFromS3Message$StorageEncrypted": "

A value that indicates whether the restored DB cluster is encrypted.

", - "RestoreDBClusterFromS3Message$EnableIAMDatabaseAuthentication": "

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

", - "RestoreDBClusterFromS3Message$DeletionProtection": "

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.

", - "RestoreDBClusterFromS3Message$CopyTagsToSnapshot": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

", - "RestoreDBClusterFromSnapshotMessage$EnableIAMDatabaseAuthentication": "

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

", - "RestoreDBClusterFromSnapshotMessage$DeletionProtection": "

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.

", - "RestoreDBClusterFromSnapshotMessage$CopyTagsToSnapshot": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

", - "RestoreDBClusterToPointInTimeMessage$EnableIAMDatabaseAuthentication": "

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

", - "RestoreDBClusterToPointInTimeMessage$DeletionProtection": "

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.

", - "RestoreDBClusterToPointInTimeMessage$CopyTagsToSnapshot": "

A value that indicates whether to copy all tags from the restored DB cluster to snapshots of the restored DB cluster. The default is not to copy them.

", - "RestoreDBInstanceFromDBSnapshotMessage$MultiAZ": "

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.

", - "RestoreDBInstanceFromDBSnapshotMessage$PubliclyAccessible": "

A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

", - "RestoreDBInstanceFromDBSnapshotMessage$AutoMinorVersionUpgrade": "

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

", - "RestoreDBInstanceFromDBSnapshotMessage$CopyTagsToSnapshot": "

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.

", - "RestoreDBInstanceFromDBSnapshotMessage$EnableIAMDatabaseAuthentication": "

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

You can enable IAM database authentication for the following database engines

", - "RestoreDBInstanceFromDBSnapshotMessage$UseDefaultProcessorFeatures": "

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

", - "RestoreDBInstanceFromDBSnapshotMessage$DeletionProtection": "

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 Instance.

", - "RestoreDBInstanceFromS3Message$MultiAZ": "

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.

", - "RestoreDBInstanceFromS3Message$AutoMinorVersionUpgrade": "

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.

", - "RestoreDBInstanceFromS3Message$PubliclyAccessible": "

A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

", - "RestoreDBInstanceFromS3Message$StorageEncrypted": "

A value that indicates whether the new DB instance is encrypted or not.

", - "RestoreDBInstanceFromS3Message$CopyTagsToSnapshot": "

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.

", - "RestoreDBInstanceFromS3Message$EnableIAMDatabaseAuthentication": "

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

", - "RestoreDBInstanceFromS3Message$EnablePerformanceInsights": "

A value that indicates whether to enable Performance Insights for the DB instance.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

", - "RestoreDBInstanceFromS3Message$UseDefaultProcessorFeatures": "

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

", - "RestoreDBInstanceFromS3Message$DeletionProtection": "

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 Instance.

", - "RestoreDBInstanceToPointInTimeMessage$MultiAZ": "

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.

", - "RestoreDBInstanceToPointInTimeMessage$PubliclyAccessible": "

A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, it is an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. When the DB instance is not publicly accessible, it is an internal instance with a DNS name that resolves to a private IP address. For more information, see CreateDBInstance.

", - "RestoreDBInstanceToPointInTimeMessage$AutoMinorVersionUpgrade": "

A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.

", - "RestoreDBInstanceToPointInTimeMessage$CopyTagsToSnapshot": "

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.

", - "RestoreDBInstanceToPointInTimeMessage$EnableIAMDatabaseAuthentication": "

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled.

You can enable IAM database authentication for the following database engines

", - "RestoreDBInstanceToPointInTimeMessage$UseDefaultProcessorFeatures": "

A value that indicates whether the DB instance class of the DB instance uses its default processor features.

", - "RestoreDBInstanceToPointInTimeMessage$DeletionProtection": "

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 Instance.

", - "ScalingConfiguration$AutoPause": "

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.

", + "RebootDBInstanceMessage$ForceFailover": "

When true, the reboot is conducted through a MultiAZ failover.

Constraint: You can't specify true if the instance is not configured for MultiAZ.

", + "RestoreDBClusterFromS3Message$StorageEncrypted": "

Specifies whether the restored DB cluster is encrypted.

", + "RestoreDBClusterFromS3Message$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

", + "RestoreDBClusterFromS3Message$DeletionProtection": "

Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

", + "RestoreDBClusterFromS3Message$CopyTagsToSnapshot": "

True to copy all tags from the restored DB cluster to snapshots of the restored DB cluster, and otherwise false. The default is false.

", + "RestoreDBClusterFromSnapshotMessage$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

", + "RestoreDBClusterFromSnapshotMessage$DeletionProtection": "

Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

", + "RestoreDBClusterFromSnapshotMessage$CopyTagsToSnapshot": "

True to copy all tags from the restored DB cluster to snapshots of the restored DB cluster, and otherwise false. The default is false.

", + "RestoreDBClusterToPointInTimeMessage$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

", + "RestoreDBClusterToPointInTimeMessage$DeletionProtection": "

Indicates if the DB cluster should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false.

", + "RestoreDBClusterToPointInTimeMessage$CopyTagsToSnapshot": "

True to copy all tags from the restored DB cluster to snapshots of the restored DB cluster, and otherwise false. The default is false.

", + "RestoreDBInstanceFromDBSnapshotMessage$MultiAZ": "

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

", + "RestoreDBInstanceFromDBSnapshotMessage$PubliclyAccessible": "

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. For more information, see CreateDBInstance.

", + "RestoreDBInstanceFromDBSnapshotMessage$AutoMinorVersionUpgrade": "

Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.

", + "RestoreDBInstanceFromDBSnapshotMessage$CopyTagsToSnapshot": "

True to copy all tags from the restored DB instance to snapshots of the restored DB instance, and otherwise false. The default is false.

", + "RestoreDBInstanceFromDBSnapshotMessage$EnableIAMDatabaseAuthentication": "

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

Default: false

", + "RestoreDBInstanceFromDBSnapshotMessage$UseDefaultProcessorFeatures": "

A value that specifies that the DB instance class of the DB instance uses its default processor features.

", + "RestoreDBInstanceFromDBSnapshotMessage$DeletionProtection": "

Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

", + "RestoreDBInstanceFromS3Message$MultiAZ": "

Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is set to true, you can't set the AvailabilityZone parameter.

", + "RestoreDBInstanceFromS3Message$AutoMinorVersionUpgrade": "

True to indicate that minor engine upgrades are applied automatically to the DB instance during the maintenance window, and otherwise false.

Default: true

", + "RestoreDBInstanceFromS3Message$PubliclyAccessible": "

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. For more information, see CreateDBInstance.

", + "RestoreDBInstanceFromS3Message$StorageEncrypted": "

Specifies whether the new DB instance is encrypted or not.

", + "RestoreDBInstanceFromS3Message$CopyTagsToSnapshot": "

True to copy all tags from the restored DB instance to snapshots of the restored DB instance, and otherwise false.

Default: false.

", + "RestoreDBInstanceFromS3Message$EnableIAMDatabaseAuthentication": "

True to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

", + "RestoreDBInstanceFromS3Message$EnablePerformanceInsights": "

True to enable Performance Insights for the DB instance, and otherwise false.

For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.

", + "RestoreDBInstanceFromS3Message$UseDefaultProcessorFeatures": "

A value that specifies that the DB instance class of the DB instance uses its default processor features.

", + "RestoreDBInstanceFromS3Message$DeletionProtection": "

Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

", + "RestoreDBInstanceToPointInTimeMessage$MultiAZ": "

Specifies if the DB instance is a Multi-AZ deployment.

Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ parameter is set to true.

", + "RestoreDBInstanceToPointInTimeMessage$PubliclyAccessible": "

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. For more information, see CreateDBInstance.

", + "RestoreDBInstanceToPointInTimeMessage$AutoMinorVersionUpgrade": "

Indicates that minor version upgrades are applied automatically to the DB instance during the maintenance window.

", + "RestoreDBInstanceToPointInTimeMessage$CopyTagsToSnapshot": "

True to copy all tags from the restored DB instance to snapshots of the restored DB instance, and otherwise false. The default is false.

", + "RestoreDBInstanceToPointInTimeMessage$EnableIAMDatabaseAuthentication": "

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

Default: false

", + "RestoreDBInstanceToPointInTimeMessage$UseDefaultProcessorFeatures": "

A value that specifies that the DB instance class of the DB instance uses its default processor features.

", + "RestoreDBInstanceToPointInTimeMessage$DeletionProtection": "

Indicates if the DB instance should have deletion protection enabled. The database can't be deleted when this value is set to true. The default is false. For more information, see Deleting a DB Instance.

", + "ScalingConfiguration$AutoPause": "

A value that specifies 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.

", "ScalingConfigurationInfo$AutoPause": "

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.

" } }, @@ -1856,7 +1857,7 @@ "refs": { "CreateDBClusterMessage$BackupRetentionPeriod": "

The number of days for which automated backups are retained.

Default: 1

Constraints:

", "CreateDBClusterMessage$Port": "

The port number on which the instances in the DB cluster accept connections.

Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql.

", - "CreateDBInstanceMessage$AllocatedStorage": "

The amount of storage (in gibibytes) to allocate for the DB instance.

Type: Integer

Amazon Aurora

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

MySQL

Constraints to the amount of storage for each storage type are the following:

MariaDB

Constraints to the amount of storage for each storage type are the following:

PostgreSQL

Constraints to the amount of storage for each storage type are the following:

Oracle

Constraints to the amount of storage for each storage type are the following:

SQL Server

Constraints to the amount of storage for each storage type are the following:

", + "CreateDBInstanceMessage$AllocatedStorage": "

The amount of storage (in gibibytes) to allocate for the DB instance.

Type: Integer

Amazon Aurora

Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.

MySQL

Constraints to the amount of storage for each storage type are the following:

MariaDB

Constraints to the amount of storage for each storage type are the following:

PostgreSQL

Constraints to the amount of storage for each storage type are the following:

Oracle

Constraints to the amount of storage for each storage type are the following:

SQL Server

Constraints to the amount of storage for each storage type are the following:

", "CreateDBInstanceMessage$BackupRetentionPeriod": "

The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster.

Default: 1

Constraints:

", "CreateDBInstanceMessage$Port": "

The port number on which the database accepts connections.

MySQL

Default: 3306

Valid Values: 1150-65535

Type: Integer

MariaDB

Default: 3306

Valid Values: 1150-65535

Type: Integer

PostgreSQL

Default: 5432

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

Amazon Aurora

Default: 3306

Valid Values: 1150-65535

Type: Integer

", "CreateDBInstanceMessage$Iops": "

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see see Amazon RDS Provisioned IOPS Storage to Improve Performance in the Amazon RDS User Guide.

Constraints: Must be a multiple between 1 and 50 of the storage amount for the DB instance.

", @@ -1910,13 +1911,13 @@ "DescribeReservedDBInstancesMessage$MaxRecords": "

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.

", "DescribeReservedDBInstancesOfferingsMessage$MaxRecords": "

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.

", "DescribeSourceRegionsMessage$MaxRecords": "

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.

", - "ModifyCurrentDBClusterCapacityMessage$Capacity": "

The DB cluster capacity.

When you change the capacity of a paused Aurora Serverless DB cluster, it automatically resumes.

Constraints:

", + "ModifyCurrentDBClusterCapacityMessage$Capacity": "

The DB cluster capacity.

When you change the capacity of a paused Aurora Serverless DB cluster, it automatically resumes.

Constraints:

", "ModifyCurrentDBClusterCapacityMessage$SecondsBeforeTimeout": "

The amount of time, in seconds, that Aurora Serverless tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.

", "ModifyDBClusterMessage$BackupRetentionPeriod": "

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

", "ModifyDBClusterMessage$Port": "

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.

", "ModifyDBInstanceMessage$AllocatedStorage": "

The new amount of storage (in gibibytes) to allocate for the DB instance.

For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

For the valid values for allocated storage for each engine, see CreateDBInstance.

", - "ModifyDBInstanceMessage$BackupRetentionPeriod": "

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

Constraints:

", - "ModifyDBInstanceMessage$Iops": "

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

Changing this setting doesn't result in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Default: Uses existing setting

", + "ModifyDBInstanceMessage$BackupRetentionPeriod": "

The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.

Changing this parameter can result in an outage if you change from 0 to a non-zero value or from a non-zero value to 0. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

Constraints:

", + "ModifyDBInstanceMessage$Iops": "

The new Provisioned IOPS (I/O operations per second) value for the RDS instance.

Changing this setting 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. If you are migrating from Provisioned IOPS to standard storage, set this value to 0. The DB instance will require a reboot for the change in storage type to take effect.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value supplied must be at least 10% greater than the current value. Values that are not at least 10% greater than the existing value are rounded up so that they are 10% greater than the current value.

Default: Uses existing setting

", "ModifyDBInstanceMessage$MonitoringInterval": "

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

", "ModifyDBInstanceMessage$DBPortNumber": "

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.

MySQL

Default: 3306

Valid Values: 1150-65535

MariaDB

Default: 3306

Valid Values: 1150-65535

PostgreSQL

Default: 5432

Valid Values: 1150-65535

Type: Integer

Oracle

Default: 1521

Valid Values: 1150-65535

SQL Server

Default: 1433

Valid Values: 1150-65535 except for 1434, 3389, 47001, 49152, and 49152 through 49156.

Amazon Aurora

Default: 3306

Valid Values: 1150-65535

", "ModifyDBInstanceMessage$PromotionTier": "

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 in the Amazon Aurora User Guide.

Default: 1

Valid Values: 0 - 15

", @@ -1949,8 +1950,8 @@ "RestoreDBInstanceFromS3Message$PerformanceInsightsRetentionPeriod": "

The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).

", "RestoreDBInstanceToPointInTimeMessage$Port": "

The port number on which the database accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB instance.

", "RestoreDBInstanceToPointInTimeMessage$Iops": "

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 is not supported.

", - "ScalingConfiguration$MinCapacity": "

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

The minimum capacity must be less than or equal to the maximum capacity.

", - "ScalingConfiguration$MaxCapacity": "

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.

The maximum capacity must be greater than or equal to the minimum capacity.

", + "ScalingConfiguration$MinCapacity": "

The minimum capacity for an Aurora DB cluster in serverless DB engine mode.

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The minimum capacity must be less than or equal to the maximum capacity.

", + "ScalingConfiguration$MaxCapacity": "

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256.

The maximum capacity must be greater than or equal to the minimum capacity.

", "ScalingConfiguration$SecondsUntilAutoPause": "

The time, in seconds, before an Aurora DB cluster in serverless mode is paused.

", "ScalingConfigurationInfo$MinCapacity": "

The maximum capacity for the Aurora DB cluster in serverless DB engine mode.

", "ScalingConfigurationInfo$MaxCapacity": "

The maximum capacity for an Aurora DB cluster in serverless DB engine mode.

", @@ -2414,7 +2415,7 @@ "EngineDefaults$Parameters": "

Contains a list of engine default parameters.

", "ModifyDBClusterParameterGroupMessage$Parameters": "

A list of parameters in the DB cluster parameter group to modify.

", "ModifyDBParameterGroupMessage$Parameters": "

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 a single request.

Valid Values (for the application method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.

", - "ResetDBClusterParameterGroupMessage$Parameters": "

A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is enabled.

", + "ResetDBClusterParameterGroupMessage$Parameters": "

A list of parameter names in the DB cluster parameter group to reset to the default values. You can't use this parameter if the ResetAllParameters parameter is set to true.

", "ResetDBParameterGroupMessage$Parameters": "

To reset the entire DB parameter group, specify the DBParameterGroup name and ResetAllParameters parameters. To reset specific parameters, provide a list of the following: ParameterName and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

MySQL

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

MariaDB

Valid Values (for Apply method): immediate | pending-reboot

You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic and static parameters, and changes are applied when DB instance reboots.

Oracle

Valid Values (for Apply method): pending-reboot

" } }, @@ -2955,7 +2956,7 @@ "CreateDBClusterMessage$PreferredBackupWindow": "

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 Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

", "CreateDBClusterMessage$PreferredMaintenanceWindow": "

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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

", "CreateDBClusterMessage$ReplicationSourceIdentifier": "

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

", - "CreateDBClusterMessage$KmsKeyId": "

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 creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.

", + "CreateDBClusterMessage$KmsKeyId": "

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 creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If an encryption key is not specified in KmsKeyId:

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a Read Replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the Read Replica in that AWS Region.

", "CreateDBClusterMessage$PreSignedUrl": "

A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster.

The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied.

The pre-signed URL request must contain the following parameter values:

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

", "CreateDBClusterMessage$EngineMode": "

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, or global.

", "CreateDBClusterMessage$GlobalClusterIdentifier": "

The global cluster ID of an Aurora cluster that becomes the primary cluster in the new global database cluster.

", @@ -2970,7 +2971,7 @@ "CreateDBInstanceMessage$Engine": "

The name of the database engine to be used for this instance.

Not every database engine is available for every AWS Region.

Valid Values:

", "CreateDBInstanceMessage$MasterUsername": "

The name for the master user.

Amazon Aurora

Not applicable. The name for the master user is managed by the DB cluster.

MariaDB

Constraints:

Microsoft SQL Server

Constraints:

MySQL

Constraints:

Oracle

Constraints:

PostgreSQL

Constraints:

", "CreateDBInstanceMessage$MasterUserPassword": "

The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster.

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

", - "CreateDBInstanceMessage$AvailabilityZone": "

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

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 DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.

", + "CreateDBInstanceMessage$AvailabilityZone": "

The Availability Zone (AZ) where the database will be created. For information on AWS Regions and Availability Zones, see Regions and Availability Zones.

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.

", "CreateDBInstanceMessage$DBSubnetGroupName": "

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.

", "CreateDBInstanceMessage$PreferredMaintenanceWindow": "

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.

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.

", "CreateDBInstanceMessage$DBParameterGroupName": "

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:

", @@ -2980,26 +2981,26 @@ "CreateDBInstanceMessage$OptionGroupName": "

Indicates that the DB instance should be associated with the specified option group.

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

", "CreateDBInstanceMessage$CharacterSetName": "

For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

Amazon Aurora

Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.

", "CreateDBInstanceMessage$DBClusterIdentifier": "

The identifier of the DB cluster that the instance will belong to.

", - "CreateDBInstanceMessage$StorageType": "

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

", + "CreateDBInstanceMessage$StorageType": "

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 standard

", "CreateDBInstanceMessage$TdeCredentialArn": "

The ARN from the key store with which to associate the instance for TDE encryption.

", "CreateDBInstanceMessage$TdeCredentialPassword": "

The password for the given ARN from the key store in order to access the device.

", - "CreateDBInstanceMessage$KmsKeyId": "

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 creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use 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.

", + "CreateDBInstanceMessage$KmsKeyId": "

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 creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

Amazon Aurora

Not applicable. The KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use 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.

", "CreateDBInstanceMessage$Domain": "

For an Amazon RDS DB instance that's running Microsoft SQL Server, this parameter specifies the Active Directory directory ID to create the instance in. Amazon RDS uses Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

", "CreateDBInstanceMessage$MonitoringRoleArn": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

", "CreateDBInstanceMessage$DomainIAMRoleName": "

Specify the name of the IAM role to be used when making API calls to the Directory Service.

", "CreateDBInstanceMessage$Timezone": "

The time zone of the DB instance. The time zone parameter is currently supported only by Microsoft SQL Server.

", - "CreateDBInstanceMessage$PerformanceInsightsKMSKeyId": "

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.

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.

", + "CreateDBInstanceMessage$PerformanceInsightsKMSKeyId": "

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.

", "CreateDBInstanceReadReplicaMessage$DBInstanceIdentifier": "

The DB instance identifier of the Read Replica. This identifier is the unique key that identifies a DB instance. This parameter is stored as a lowercase string.

", "CreateDBInstanceReadReplicaMessage$SourceDBInstanceIdentifier": "

The identifier of the DB instance that will act as the source for the Read Replica. Each DB instance can have up to five Read Replicas.

Constraints:

", "CreateDBInstanceReadReplicaMessage$DBInstanceClass": "

The compute and memory capacity of the Read Replica, 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 in the Amazon RDS User Guide.

Default: Inherits from the source DB instance.

", "CreateDBInstanceReadReplicaMessage$AvailabilityZone": "

The Availability Zone (AZ) where the Read Replica will be created.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

", "CreateDBInstanceReadReplicaMessage$OptionGroupName": "

The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.

", "CreateDBInstanceReadReplicaMessage$DBSubnetGroupName": "

Specifies a DB subnet group for the DB instance. The new DB instance is created in the VPC associated with the DB subnet group. If no DB subnet group is specified, then the new DB instance is not created in a VPC.

Constraints:

Example: mySubnetgroup

", - "CreateDBInstanceReadReplicaMessage$StorageType": "

Specifies the storage type to be associated with the Read Replica.

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

", + "CreateDBInstanceReadReplicaMessage$StorageType": "

Specifies the storage type to be associated with the Read Replica.

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 standard

", "CreateDBInstanceReadReplicaMessage$MonitoringRoleArn": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

", "CreateDBInstanceReadReplicaMessage$KmsKeyId": "

The AWS KMS key ID for an encrypted Read Replica. 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 create an encrypted Read Replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The Read Replica is encrypted with the same KMS key as the source DB instance.

If you create an encrypted Read Replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. 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 can't create an encrypted Read Replica from an unencrypted DB instance.

", "CreateDBInstanceReadReplicaMessage$PreSignedUrl": "

The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source AWS Region that contains the source DB instance.

You must specify this parameter when you create an encrypted Read Replica from another AWS Region by using the Amazon RDS API. You can specify the --source-region option instead of this parameter when you create an encrypted Read Replica from another AWS Region by using the AWS CLI.

The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source AWS Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values:

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process.

", - "CreateDBInstanceReadReplicaMessage$PerformanceInsightsKMSKeyId": "

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.

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.

", + "CreateDBInstanceReadReplicaMessage$PerformanceInsightsKMSKeyId": "

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.

", "CreateDBParameterGroupMessage$DBParameterGroupName": "

The name of the DB parameter group.

Constraints:

This value is stored as a lowercase string.

", "CreateDBParameterGroupMessage$DBParameterGroupFamily": "

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.

To list all of the available parameter group families, use the following command:

aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"

The output contains duplicates.

", "CreateDBParameterGroupMessage$Description": "

The description for the DB parameter group.

", @@ -3037,7 +3038,7 @@ "DBCluster$PreferredMaintenanceWindow": "

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

", "DBCluster$ReplicationSourceIdentifier": "

Contains the identifier of the source DB cluster if this DB cluster is a Read Replica.

", "DBCluster$HostedZoneId": "

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

", - "DBCluster$KmsKeyId": "

If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.

", + "DBCluster$KmsKeyId": "

If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.

", "DBCluster$DbClusterResourceId": "

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.

", "DBCluster$DBClusterArn": "

The Amazon Resource Name (ARN) for the DB cluster.

", "DBCluster$CloneGroupId": "

Identifies the clone group to which the DB cluster is associated.

", @@ -3092,6 +3093,7 @@ "DBEngineVersion$DBParameterGroupFamily": "

The name of the DB parameter group family for the database engine.

", "DBEngineVersion$DBEngineDescription": "

The description of the database engine.

", "DBEngineVersion$DBEngineVersionDescription": "

The description of the database engine version.

", + "DBEngineVersion$Status": "

The status of the DB engine version, either available or deprecated.

", "DBEngineVersionMessage$Marker": "

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.

", "DBInstance$DBInstanceIdentifier": "

Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

", "DBInstance$DBInstanceClass": "

Contains the name of the compute and memory capacity class of the DB instance.

", @@ -3190,12 +3192,12 @@ "DBSubnetGroupMessage$Marker": "

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.

", "DeleteDBClusterEndpointMessage$DBClusterEndpointIdentifier": "

The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.

", "DeleteDBClusterMessage$DBClusterIdentifier": "

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

Constraints:

", - "DeleteDBClusterMessage$FinalDBSnapshotIdentifier": "

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

Constraints:

", + "DeleteDBClusterMessage$FinalDBSnapshotIdentifier": "

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

", "DeleteDBClusterParameterGroupMessage$DBClusterParameterGroupName": "

The name of the DB cluster parameter group.

Constraints:

", "DeleteDBClusterSnapshotMessage$DBClusterSnapshotIdentifier": "

The identifier of the DB cluster snapshot to delete.

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

", "DeleteDBInstanceAutomatedBackupMessage$DbiResourceId": "

The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.

", "DeleteDBInstanceMessage$DBInstanceIdentifier": "

The DB instance identifier for the DB instance to be deleted. This parameter isn't case-sensitive.

Constraints:

", - "DeleteDBInstanceMessage$FinalDBSnapshotIdentifier": "

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

Constraints:

", + "DeleteDBInstanceMessage$FinalDBSnapshotIdentifier": "

The DBSnapshotIdentifier of the new DB snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

", "DeleteDBParameterGroupMessage$DBParameterGroupName": "

The name of the DB parameter group.

Constraints:

", "DeleteDBSecurityGroupMessage$DBSecurityGroupName": "

The name of the DB security group to delete.

You can't delete the default DB security group.

Constraints:

", "DeleteDBSnapshotMessage$DBSnapshotIdentifier": "

The DB snapshot identifier.

Constraints: Must be the name of an existing DB snapshot in the available state.

", @@ -3219,7 +3221,7 @@ "DescribeDBClusterSnapshotAttributesMessage$DBClusterSnapshotIdentifier": "

The identifier for the DB cluster snapshot to describe the attributes for.

", "DescribeDBClusterSnapshotsMessage$DBClusterIdentifier": "

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

Constraints:

", "DescribeDBClusterSnapshotsMessage$DBClusterSnapshotIdentifier": "

A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

", - "DescribeDBClusterSnapshotsMessage$SnapshotType": "

The type of DB cluster snapshots to be returned. You can specify one of the following values:

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling the IncludeShared parameter. You can include public DB cluster snapshots with these results by enabling the IncludePublic parameter.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

", + "DescribeDBClusterSnapshotsMessage$SnapshotType": "

The type of DB cluster snapshots to be returned. You can specify one of the following values:

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

", "DescribeDBClusterSnapshotsMessage$Marker": "

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.

", "DescribeDBClustersMessage$DBClusterIdentifier": "

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:

", "DescribeDBClustersMessage$Marker": "

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.

", @@ -3247,7 +3249,7 @@ "DescribeDBSnapshotAttributesMessage$DBSnapshotIdentifier": "

The identifier for the DB snapshot to describe the attributes for.

", "DescribeDBSnapshotsMessage$DBInstanceIdentifier": "

The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in conjunction with DBSnapshotIdentifier. This parameter is not case-sensitive.

Constraints:

", "DescribeDBSnapshotsMessage$DBSnapshotIdentifier": "

A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with DBInstanceIdentifier. This value is stored as a lowercase string.

Constraints:

", - "DescribeDBSnapshotsMessage$SnapshotType": "

The type of snapshots to be returned. You can specify one of the following values:

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by enabling the IncludeShared parameter. You can include public snapshots with these results by enabling the IncludePublic parameter.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

", + "DescribeDBSnapshotsMessage$SnapshotType": "

The type of snapshots to be returned. You can specify one of the following values:

If you don't specify a SnapshotType value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not included in the returned results by default. You can include shared snapshots with these results by setting the IncludeShared parameter to true. You can include public snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

", "DescribeDBSnapshotsMessage$Marker": "

An optional pagination token provided by a previous DescribeDBSnapshots request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

", "DescribeDBSnapshotsMessage$DbiResourceId": "

A specific DB resource ID to describe.

", "DescribeDBSubnetGroupsMessage$DBSubnetGroupName": "

The name of the DB subnet group to return details for.

", @@ -3354,32 +3356,32 @@ "ModifyDBClusterMessage$NewDBClusterIdentifier": "

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value is stored as a lowercase string.

Constraints:

Example: my-cluster2

", "ModifyDBClusterMessage$DBClusterParameterGroupName": "

The name of the DB cluster parameter group to use for the DB cluster.

", "ModifyDBClusterMessage$MasterUserPassword": "

The new password for the master database user. This password can contain any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain from 8 to 41 characters.

", - "ModifyDBClusterMessage$OptionGroupName": "

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

", + "ModifyDBClusterMessage$OptionGroupName": "

A value that indicates that the DB cluster should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case, and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

Permanent options can't be removed from an option group. The option group can't be removed from a DB cluster once it is associated with a DB cluster.

", "ModifyDBClusterMessage$PreferredBackupWindow": "

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 Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Constraints:

", "ModifyDBClusterMessage$PreferredMaintenanceWindow": "

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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

", - "ModifyDBClusterMessage$EngineVersion": "

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 maintenance window unless ApplyImmediately is enabled.

For a list of valid engine versions, use DescribeDBEngineVersions.

", + "ModifyDBClusterMessage$EngineVersion": "

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 maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, use the DescribeDBEngineVersions action.

", "ModifyDBClusterParameterGroupMessage$DBClusterParameterGroupName": "

The name of the DB cluster parameter group to modify.

", "ModifyDBClusterSnapshotAttributeMessage$DBClusterSnapshotIdentifier": "

The identifier for the DB cluster snapshot to modify the attributes for.

", "ModifyDBClusterSnapshotAttributeMessage$AttributeName": "

The name of the DB cluster snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB cluster snapshot, set this value to restore.

", "ModifyDBInstanceMessage$DBInstanceIdentifier": "

The DB instance identifier. This value is stored as a lowercase string.

Constraints:

", - "ModifyDBInstanceMessage$DBInstanceClass": "

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, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request.

Default: Uses existing setting

", - "ModifyDBInstanceMessage$DBSubnetGroupName": "

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetGroup

", + "ModifyDBInstanceMessage$DBInstanceClass": "

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, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide.

If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is specified as true for this request.

Default: Uses existing setting

", + "ModifyDBInstanceMessage$DBSubnetGroupName": "

The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance is not in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Updating the VPC for a DB Instance in the Amazon RDS User Guide.

Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you specify true for the ApplyImmediately parameter.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetGroup

", "ModifyDBInstanceMessage$MasterUserPassword": "

The new password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Amazon Aurora

Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster.

Default: Uses existing setting

MariaDB

Constraints: Must contain from 8 to 41 characters.

Microsoft SQL Server

Constraints: Must contain from 8 to 128 characters.

MySQL

Constraints: Must contain from 8 to 41 characters.

Oracle

Constraints: Must contain from 8 to 30 characters.

PostgreSQL

Constraints: Must contain from 8 to 128 characters.

Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.

", "ModifyDBInstanceMessage$DBParameterGroupName": "

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.

", "ModifyDBInstanceMessage$PreferredBackupWindow": "

The daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod parameter. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.

Amazon Aurora

Not applicable. The daily time range for creating automated backups is managed by the DB cluster. For more information, see ModifyDBCluster.

Constraints:

", "ModifyDBInstanceMessage$PreferredMaintenanceWindow": "

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

", - "ModifyDBInstanceMessage$EngineVersion": "

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is eanbled for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

", + "ModifyDBInstanceMessage$EngineVersion": "

The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request.

For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family.

For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

", "ModifyDBInstanceMessage$LicenseModel": "

The license model for the DB instance.

Valid values: license-included | bring-your-own-license | general-public-license

", - "ModifyDBInstanceMessage$OptionGroupName": "

Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

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

", - "ModifyDBInstanceMessage$NewDBInstanceIdentifier": "

The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string.

Constraints:

Example: mydbinstance

", - "ModifyDBInstanceMessage$StorageType": "

Specifies the storage type to be associated with the DB instance.

If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

Valid values: standard | gp2 | io1

Default: io1 if the Iops parameter is specified, otherwise gp2

", + "ModifyDBInstanceMessage$OptionGroupName": "

Indicates that the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage except in the following case and the change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true for this request. If the parameter change results in an option group that enables OEM, this change can cause a brief (sub-second) period during which new connections are rejected but existing connections are not interrupted.

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

", + "ModifyDBInstanceMessage$NewDBInstanceIdentifier": "

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 maintenance window if Apply Immediately to false. This value is stored as a lowercase string.

Constraints:

Example: mydbinstance

", + "ModifyDBInstanceMessage$StorageType": "

Specifies the storage type to be associated with the DB instance.

If you specify Provisioned IOPS (io1), you must also include a value for the Iops parameter.

If you choose to migrate your DB instance from using standard storage to using Provisioned IOPS, or from using Provisioned IOPS to using standard storage, the process can take time. The duration of the migration depends on several factors such as database load, storage size, storage type (standard or Provisioned IOPS), amount of IOPS provisioned (if any), and the number of prior scale storage operations. Typical migration times are under 24 hours, but the process can take up to several days in some cases. During the migration, the DB instance is available for use, but might experience performance degradation. While the migration takes place, nightly backups for the instance are suspended. No other Amazon RDS operations can take place for the instance, including modifying the instance, rebooting the instance, deleting the instance, creating a Read Replica for the instance, and creating a DB snapshot of the instance.

Valid values: standard | gp2 | io1

Default: io1 if the Iops parameter is specified, otherwise standard

", "ModifyDBInstanceMessage$TdeCredentialArn": "

The ARN from the key store with which to associate the instance for TDE encryption.

", "ModifyDBInstanceMessage$TdeCredentialPassword": "

The password for the given ARN from the key store in order to access the device.

", "ModifyDBInstanceMessage$CACertificateIdentifier": "

Indicates the certificate that needs to be associated with the instance.

", "ModifyDBInstanceMessage$Domain": "

The Active Directory Domain to move the instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently only a Microsoft SQL Server instance can be created in a Active Directory Domain.

", "ModifyDBInstanceMessage$MonitoringRoleArn": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

", "ModifyDBInstanceMessage$DomainIAMRoleName": "

The name of the IAM role to use when making API calls to the Directory Service.

", - "ModifyDBInstanceMessage$PerformanceInsightsKMSKeyId": "

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.

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.

", + "ModifyDBInstanceMessage$PerformanceInsightsKMSKeyId": "

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.

", "ModifyDBParameterGroupMessage$DBParameterGroupName": "

The name of the DB parameter group.

Constraints:

", "ModifyDBSnapshotAttributeMessage$DBSnapshotIdentifier": "

The identifier for the DB snapshot to modify the attributes for.

", "ModifyDBSnapshotAttributeMessage$AttributeName": "

The name of the DB snapshot attribute to modify.

To manage authorization for other AWS accounts to copy or restore a manual DB snapshot, set this value to restore.

", @@ -3510,7 +3512,7 @@ "RestoreDBClusterFromS3Message$OptionGroupName": "

A value that indicates that the restored DB cluster should be associated with the specified option group.

Permanent options can't be removed from an option group. An option group can't be removed from a DB cluster once it is associated with a DB cluster.

", "RestoreDBClusterFromS3Message$PreferredBackupWindow": "

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 Region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Constraints:

", "RestoreDBClusterFromS3Message$PreferredMaintenanceWindow": "

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. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon Aurora User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

", - "RestoreDBClusterFromS3Message$KmsKeyId": "

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 creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use 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.

", + "RestoreDBClusterFromS3Message$KmsKeyId": "

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 creating a DB cluster with the same AWS account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use 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.

", "RestoreDBClusterFromS3Message$SourceEngine": "

The identifier for the database engine that was backed up to create the files stored in the Amazon S3 bucket.

Valid values: mysql

", "RestoreDBClusterFromS3Message$SourceEngineVersion": "

The version of the database that the backup files were created from.

MySQL version 5.5 and 5.6 are supported.

Example: 5.6.22

", "RestoreDBClusterFromS3Message$S3BucketName": "

The name of the Amazon S3 bucket that contains the data used to create the Amazon Aurora DB cluster.

", @@ -3536,13 +3538,13 @@ "RestoreDBInstanceFromDBSnapshotMessage$DBInstanceIdentifier": "

Name of the DB instance to create from the DB snapshot. This parameter isn't case-sensitive.

Constraints:

Example: my-snapshot-id

", "RestoreDBInstanceFromDBSnapshotMessage$DBSnapshotIdentifier": "

The identifier for the DB snapshot to restore from.

Constraints:

", "RestoreDBInstanceFromDBSnapshotMessage$DBInstanceClass": "

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 in the Amazon RDS User Guide.

Default: The same DBInstanceClass as the original DB instance.

", - "RestoreDBInstanceFromDBSnapshotMessage$AvailabilityZone": "

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

", + "RestoreDBInstanceFromDBSnapshotMessage$AvailabilityZone": "

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 MultiAZ parameter is set to true.

Example: us-east-1a

", "RestoreDBInstanceFromDBSnapshotMessage$DBSubnetGroupName": "

The DB subnet group name to use for the new instance.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

", "RestoreDBInstanceFromDBSnapshotMessage$LicenseModel": "

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

", "RestoreDBInstanceFromDBSnapshotMessage$DBName": "

The database name for the restored DB instance.

This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines.

", "RestoreDBInstanceFromDBSnapshotMessage$Engine": "

The database engine to use for the new instance.

Default: The same as source

Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot.

Valid Values:

", "RestoreDBInstanceFromDBSnapshotMessage$OptionGroupName": "

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

", - "RestoreDBInstanceFromDBSnapshotMessage$StorageType": "

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

", + "RestoreDBInstanceFromDBSnapshotMessage$StorageType": "

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 standard

", "RestoreDBInstanceFromDBSnapshotMessage$TdeCredentialArn": "

The ARN from the key store with which to associate the instance for TDE encryption.

", "RestoreDBInstanceFromDBSnapshotMessage$TdeCredentialPassword": "

The password for the given ARN from the key store in order to access the device.

", "RestoreDBInstanceFromDBSnapshotMessage$Domain": "

Specify the Active Directory Domain to restore the instance in.

", @@ -3554,7 +3556,7 @@ "RestoreDBInstanceFromS3Message$Engine": "

The name of the database engine to be used for this instance.

Valid Values: mysql

", "RestoreDBInstanceFromS3Message$MasterUsername": "

The name for the master user.

Constraints:

", "RestoreDBInstanceFromS3Message$MasterUserPassword": "

The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\".

Constraints: Must contain from 8 to 41 characters.

", - "RestoreDBInstanceFromS3Message$AvailabilityZone": "

The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.

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 DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.

", + "RestoreDBInstanceFromS3Message$AvailabilityZone": "

The Availability Zone that the DB instance is created in. For information about AWS Regions and Availability Zones, see Regions and Availability Zones in the Amazon RDS User Guide.

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.

", "RestoreDBInstanceFromS3Message$DBSubnetGroupName": "

A DB subnet group to associate with this DB instance.

", "RestoreDBInstanceFromS3Message$PreferredMaintenanceWindow": "

The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide.

Constraints:

", "RestoreDBInstanceFromS3Message$DBParameterGroupName": "

The name of the DB parameter group to associate with this DB instance. If this argument is omitted, the default parameter group for the specified engine is used.

", @@ -3562,25 +3564,25 @@ "RestoreDBInstanceFromS3Message$EngineVersion": "

The version number of the database engine to use. Choose the latest minor version of your database engine. For information about engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.

", "RestoreDBInstanceFromS3Message$LicenseModel": "

The license model for this DB instance. Use general-public-license.

", "RestoreDBInstanceFromS3Message$OptionGroupName": "

The name of the option group to associate with this DB instance. If this argument is omitted, the default option group for the specified engine is used.

", - "RestoreDBInstanceFromS3Message$StorageType": "

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

", - "RestoreDBInstanceFromS3Message$KmsKeyId": "

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 creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use 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.

", + "RestoreDBInstanceFromS3Message$StorageType": "

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 standard

", + "RestoreDBInstanceFromS3Message$KmsKeyId": "

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 creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.

If the StorageEncrypted parameter is true, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use 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.

", "RestoreDBInstanceFromS3Message$MonitoringRoleArn": "

The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide.

If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.

", "RestoreDBInstanceFromS3Message$SourceEngine": "

The name of the engine of your source database.

Valid Values: mysql

", "RestoreDBInstanceFromS3Message$SourceEngineVersion": "

The engine version of your source database.

Valid Values: 5.6

", "RestoreDBInstanceFromS3Message$S3BucketName": "

The name of your Amazon S3 bucket that contains your database backup file.

", "RestoreDBInstanceFromS3Message$S3Prefix": "

The prefix of your Amazon S3 bucket.

", "RestoreDBInstanceFromS3Message$S3IngestionRoleArn": "

An AWS Identity and Access Management (IAM) role to allow Amazon RDS to access your Amazon S3 bucket.

", - "RestoreDBInstanceFromS3Message$PerformanceInsightsKMSKeyId": "

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.

", + "RestoreDBInstanceFromS3Message$PerformanceInsightsKMSKeyId": "

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.

", "RestoreDBInstanceToPointInTimeMessage$SourceDBInstanceIdentifier": "

The identifier of the source DB instance from which to restore.

Constraints:

", "RestoreDBInstanceToPointInTimeMessage$TargetDBInstanceIdentifier": "

The name of the new DB instance to be created.

Constraints:

", "RestoreDBInstanceToPointInTimeMessage$DBInstanceClass": "

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 in the Amazon RDS User Guide.

Default: The same DBInstanceClass as the original DB instance.

", - "RestoreDBInstanceToPointInTimeMessage$AvailabilityZone": "

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

", + "RestoreDBInstanceToPointInTimeMessage$AvailabilityZone": "

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 MultiAZ parameter is set to true.

Example: us-east-1a

", "RestoreDBInstanceToPointInTimeMessage$DBSubnetGroupName": "

The DB subnet group name to use for the new instance.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

", "RestoreDBInstanceToPointInTimeMessage$LicenseModel": "

License model information for the restored DB instance.

Default: Same as source.

Valid values: license-included | bring-your-own-license | general-public-license

", "RestoreDBInstanceToPointInTimeMessage$DBName": "

The database name for the restored DB instance.

This parameter is not used for the MySQL or MariaDB engines.

", "RestoreDBInstanceToPointInTimeMessage$Engine": "

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:

", "RestoreDBInstanceToPointInTimeMessage$OptionGroupName": "

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

", - "RestoreDBInstanceToPointInTimeMessage$StorageType": "

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

", + "RestoreDBInstanceToPointInTimeMessage$StorageType": "

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 standard

", "RestoreDBInstanceToPointInTimeMessage$TdeCredentialArn": "

The ARN from the key store with which to associate the instance for TDE encryption.

", "RestoreDBInstanceToPointInTimeMessage$TdeCredentialPassword": "

The password for the given ARN from the key store in order to access the device.

", "RestoreDBInstanceToPointInTimeMessage$Domain": "

Specify the Active Directory Domain to restore the instance in.

", @@ -3592,7 +3594,7 @@ "RevokeDBSecurityGroupIngressMessage$EC2SecurityGroupName": "

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.

", "RevokeDBSecurityGroupIngressMessage$EC2SecurityGroupId": "

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.

", "RevokeDBSecurityGroupIngressMessage$EC2SecurityGroupOwnerId": "

The AWS Account Number of the owner of the EC2 security group specified in the EC2SecurityGroupName parameter. The AWS Access Key ID is not an acceptable value. For VPC DB security groups, EC2SecurityGroupId must be provided. Otherwise, EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId must be provided.

", - "ScalingConfiguration$TimeoutAction": "

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.

RollbackCapacityChange, the default, ignores the capacity change if a scaling point is not found in the timeout period.

If you specify ForceApplyCapacityChange, connections that prevent Aurora Serverless from finding a scaling point might be dropped.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

", + "ScalingConfiguration$TimeoutAction": "

The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.

ForceApplyCapacityChange, the default, sets the capacity to the specified value as soon as possible.

RollbackCapacityChange ignores the capacity change if a scaling point is not found in the timeout period.

For more information, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide.

", "ScalingConfigurationInfo$TimeoutAction": "

The timeout action of a call to ModifyCurrentDBClusterCapacity, either ForceApplyCapacityChange or RollbackCapacityChange.

", "SourceIdsList$member": null, "SourceRegion$RegionName": "

The name of the source AWS Region.

", @@ -3710,8 +3712,8 @@ "PendingMaintenanceAction$ForcedApplyDate": "

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.

", "PendingMaintenanceAction$CurrentApplyDate": "

The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the ApplyPendingMaintenanceAction API, the AutoAppliedAfterDate, and the ForcedApplyDate. This value is blank if an opt-in request has not been received and nothing has been specified as AutoAppliedAfterDate or ForcedApplyDate.

", "ReservedDBInstance$StartTime": "

The time the reservation started.

", - "RestoreDBClusterToPointInTimeMessage$RestoreToTime": "

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

Example: 2015-03-07T23:45:00Z

", - "RestoreDBInstanceToPointInTimeMessage$RestoreTime": "

The date and time to restore from.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

Example: 2009-09-07T23:45:00Z

", + "RestoreDBClusterToPointInTimeMessage$RestoreToTime": "

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

Example: 2015-03-07T23:45:00Z

", + "RestoreDBInstanceToPointInTimeMessage$RestoreTime": "

The date and time to restore from.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

Example: 2009-09-07T23:45:00Z

", "RestoreWindow$EarliestTime": "

The earliest time you can restore an instance to.

", "RestoreWindow$LatestTime": "

The latest time you can restore an instance to.

" } diff --git a/models/apis/robomaker/2018-06-29/api-2.json b/models/apis/robomaker/2018-06-29/api-2.json index 52b14752145..b0f4a33917e 100644 --- a/models/apis/robomaker/2018-06-29/api-2.json +++ b/models/apis/robomaker/2018-06-29/api-2.json @@ -28,6 +28,21 @@ {"shape":"ThrottlingException"} ] }, + "CancelDeploymentJob":{ + "name":"CancelDeploymentJob", + "http":{ + "method":"POST", + "requestUri":"/cancelDeploymentJob" + }, + "input":{"shape":"CancelDeploymentJobRequest"}, + "output":{"shape":"CancelDeploymentJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} + ] + }, "CancelSimulationJob":{ "name":"CancelSimulationJob", "http":{ @@ -587,6 +602,18 @@ } }, "Boolean":{"type":"boolean"}, + "CancelDeploymentJobRequest":{ + "type":"structure", + "required":["job"], + "members":{ + "job":{"shape":"Arn"} + } + }, + "CancelDeploymentJobResponse":{ + "type":"structure", + "members":{ + } + }, "CancelSimulationJobRequest":{ "type":"structure", "required":["job"], @@ -821,6 +848,7 @@ "members":{ "arn":{"shape":"Arn"}, "status":{"shape":"SimulationJobStatus"}, + "lastStartedAt":{"shape":"LastStartedAt"}, "lastUpdatedAt":{"shape":"LastUpdatedAt"}, "failureBehavior":{"shape":"FailureBehavior"}, "failureCode":{"shape":"SimulationJobErrorCode"}, @@ -973,7 +1001,8 @@ "Preparing", "InProgress", "Failed", - "Succeeded" + "Succeeded", + "Canceled" ] }, "DeploymentVersion":{ @@ -1121,6 +1150,7 @@ "arn":{"shape":"Arn"}, "name":{"shape":"Name"}, "status":{"shape":"SimulationJobStatus"}, + "lastStartedAt":{"shape":"LastStartedAt"}, "lastUpdatedAt":{"shape":"LastUpdatedAt"}, "failureBehavior":{"shape":"FailureBehavior"}, "failureCode":{"shape":"SimulationJobErrorCode"}, @@ -1235,6 +1265,7 @@ "exception":true }, "JobDuration":{"type":"long"}, + "LastStartedAt":{"type":"timestamp"}, "LastUpdatedAt":{"type":"timestamp"}, "LaunchConfig":{ "type":"structure", @@ -1527,7 +1558,8 @@ "name":{"shape":"Name"}, "arn":{"shape":"Arn"}, "version":{"shape":"Version"}, - "lastUpdatedAt":{"shape":"LastUpdatedAt"} + "lastUpdatedAt":{"shape":"LastUpdatedAt"}, + "robotSoftwareSuite":{"shape":"RobotSoftwareSuite"} } }, "RobotDeployment":{ @@ -1645,7 +1677,9 @@ "name":{"shape":"Name"}, "arn":{"shape":"Arn"}, "version":{"shape":"Version"}, - "lastUpdatedAt":{"shape":"LastUpdatedAt"} + "lastUpdatedAt":{"shape":"LastUpdatedAt"}, + "robotSoftwareSuite":{"shape":"RobotSoftwareSuite"}, + "simulationSoftwareSuite":{"shape":"SimulationSoftwareSuite"} } }, "SimulationJob":{ @@ -1654,6 +1688,7 @@ "arn":{"shape":"Arn"}, "name":{"shape":"Name"}, "status":{"shape":"SimulationJobStatus"}, + "lastStartedAt":{"shape":"LastStartedAt"}, "lastUpdatedAt":{"shape":"LastUpdatedAt"}, "failureBehavior":{"shape":"FailureBehavior"}, "failureCode":{"shape":"SimulationJobErrorCode"}, diff --git a/models/apis/robomaker/2018-06-29/docs-2.json b/models/apis/robomaker/2018-06-29/docs-2.json index 69e8a277f60..fdda7f583ae 100644 --- a/models/apis/robomaker/2018-06-29/docs-2.json +++ b/models/apis/robomaker/2018-06-29/docs-2.json @@ -3,6 +3,7 @@ "service": "

This section provides documentation for the AWS RoboMaker API operations.

", "operations": { "BatchDescribeSimulationJob": "

Describes one or more simulation jobs.

", + "CancelDeploymentJob": "

Cancels the specified deployment job.

", "CancelSimulationJob": "

Cancels the specified simulation job.

", "CreateDeploymentJob": "

Deploys a specific version of a robot application to robots in a fleet.

The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version.

After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.

", "CreateFleet": "

Creates a fleet, a logical group of robots running the same robot application.

", @@ -54,6 +55,7 @@ "base": null, "refs": { "Arns$member": null, + "CancelDeploymentJobRequest$job": "

The deployment job ARN to cancel.

", "CancelSimulationJobRequest$job": "

The simulation job ARN to cancel.

", "CreateDeploymentJobRequest$fleet": "

The Amazon Resource Name (ARN) of the fleet to deploy.

", "CreateDeploymentJobResponse$arn": "

The Amazon Resource Name (ARN) of the deployment job.

", @@ -147,6 +149,16 @@ "VPCConfigResponse$assignPublicIp": "

A boolean indicating if a public IP was assigned.

" } }, + "CancelDeploymentJobRequest": { + "base": null, + "refs": { + } + }, + "CancelDeploymentJobResponse": { + "base": null, + "refs": { + } + }, "CancelSimulationJobRequest": { "base": null, "refs": { @@ -555,7 +567,7 @@ "CreateSimulationJobRequest$iamRole": "

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.

", "CreateSimulationJobResponse$iamRole": "

The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.

", "DescribeSimulationJobResponse$iamRole": "

The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.

", - "SimulationJob$iamRole": "

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. See how to specify AWS security credentials for your application.

" + "SimulationJob$iamRole": "

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.

" } }, "Id": { @@ -591,6 +603,14 @@ "SimulationJob$maxJobDurationInSeconds": "

The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

" } }, + "LastStartedAt": { + "base": null, + "refs": { + "CreateSimulationJobResponse$lastStartedAt": "

The time, in milliseconds since the epoch, when the simulation job was last started.

", + "DescribeSimulationJobResponse$lastStartedAt": "

The time, in milliseconds since the epoch, when the simulation job was last started.

", + "SimulationJob$lastStartedAt": "

The time, in milliseconds since the epoch, when the simulation job was last started.

" + } + }, "LastUpdatedAt": { "base": null, "refs": { @@ -905,7 +925,7 @@ "RobotDeploymentStep": { "base": null, "refs": { - "ProgressDetail$currentProgress": "

The current progress status.

Validating

Validating the deployment.

Downloading/Extracting

Downloading and extracting the bundle on the robot.

Executing pre-launch script(s)

Executing pre-launch script(s) if provided.

Launching

Launching the robot application.

Executing post-launch script(s)

Executing post-launch script(s) if provided.

Finished

Deployment is complete.

" + "ProgressDetail$currentProgress": "

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

Launching the robot application.

ExecutingPostLaunch

Executing post-launch script(s) if provided.

Finished

Deployment is complete.

" } }, "RobotDeploymentSummary": { @@ -925,6 +945,8 @@ "CreateSimulationApplicationVersionResponse$robotSoftwareSuite": "

Information about the robot software suite.

", "DescribeRobotApplicationResponse$robotSoftwareSuite": "

The robot software suite used by the robot application.

", "DescribeSimulationApplicationResponse$robotSoftwareSuite": "

Information about the robot software suite.

", + "RobotApplicationSummary$robotSoftwareSuite": "

Information about a robot software suite.

", + "SimulationApplicationSummary$robotSoftwareSuite": "

Information about a robot software suite.

", "UpdateRobotApplicationRequest$robotSoftwareSuite": "

The robot software suite used by the robot application.

", "UpdateRobotApplicationResponse$robotSoftwareSuite": "

The robot software suite used by the robot application.

", "UpdateSimulationApplicationRequest$robotSoftwareSuite": "

Information about the robot software suite.

", @@ -1068,6 +1090,7 @@ "CreateSimulationApplicationResponse$simulationSoftwareSuite": "

The simulation software suite used by the simulation application.

", "CreateSimulationApplicationVersionResponse$simulationSoftwareSuite": "

The simulation software suite used by the simulation application.

", "DescribeSimulationApplicationResponse$simulationSoftwareSuite": "

The simulation software suite used by the simulation application.

", + "SimulationApplicationSummary$simulationSoftwareSuite": "

Information about a simulation software suite.

", "UpdateSimulationApplicationRequest$simulationSoftwareSuite": "

The simulation software suite used by the simulation application.

", "UpdateSimulationApplicationResponse$simulationSoftwareSuite": "

The simulation software suite used by the simulation application.

" } diff --git a/models/apis/storagegateway/2013-06-30/api-2.json b/models/apis/storagegateway/2013-06-30/api-2.json index 3cdc00b0d88..98aa7ae6f5d 100644 --- a/models/apis/storagegateway/2013-06-30/api-2.json +++ b/models/apis/storagegateway/2013-06-30/api-2.json @@ -77,6 +77,19 @@ {"shape":"InternalServerError"} ] }, + "AssignTapePool":{ + "name":"AssignTapePool", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"AssignTapePoolInput"}, + "output":{"shape":"AssignTapePoolOutput"}, + "errors":[ + {"shape":"InvalidGatewayRequestException"}, + {"shape":"InternalServerError"} + ] + }, "AttachVolume":{ "name":"AttachVolume", "http":{ @@ -1037,6 +1050,23 @@ "GatewayARN":{"shape":"GatewayARN"} } }, + "AssignTapePoolInput":{ + "type":"structure", + "required":[ + "TapeARN", + "PoolId" + ], + "members":{ + "TapeARN":{"shape":"TapeARN"}, + "PoolId":{"shape":"PoolId"} + } + }, + "AssignTapePoolOutput":{ + "type":"structure", + "members":{ + "TapeARN":{"shape":"TapeARN"} + } + }, "AttachVolumeInput":{ "type":"structure", "required":[ @@ -1150,7 +1180,8 @@ "ChapSecret":{ "type":"string", "max":100, - "min":1 + "min":1, + "sensitive":true }, "ClientToken":{ "type":"string", diff --git a/models/apis/storagegateway/2013-06-30/docs-2.json b/models/apis/storagegateway/2013-06-30/docs-2.json index d786d2a8e74..74733eb6a2f 100644 --- a/models/apis/storagegateway/2013-06-30/docs-2.json +++ b/models/apis/storagegateway/2013-06-30/docs-2.json @@ -7,6 +7,7 @@ "AddTagsToResource": "

Adds one or more tags to the specified resource. You use tags to add metadata to resources, which you can use to categorize these resources. For example, you can categorize resources by purpose, owner, environment, or team. Each tag consists of a key and a value, which you define. You can add tags to the following AWS Storage Gateway resources:

You can create a maximum of 50 tags for each resource. Virtual tapes and storage volumes that are recovered to a new gateway maintain their tags.

", "AddUploadBuffer": "

Configures one or more gateway local disks as upload buffer for a specified gateway. This operation is supported for the stored volume, cached volume and tape gateway types.

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add upload buffer, and one or more disk IDs that you want to configure as upload buffer.

", "AddWorkingStorage": "

Configures one or more gateway local disks as working storage for a gateway. This operation is only supported in the stored volume gateway type. This operation is deprecated in cached volume API version 20120630. Use AddUploadBuffer instead.

Working storage is also referred to as upload buffer. You can also use the AddUploadBuffer operation to add upload buffer to a stored volume gateway.

In the request, you specify the gateway Amazon Resource Name (ARN) to which you want to add working storage, and one or more disk IDs that you want to configure as working storage.

", + "AssignTapePool": "

Assigns a tape to a tape pool for archiving. The tape assigned to a 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 S3 storage class (Glacier or Deep Archive) that corresponds to the pool.

Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

", "AttachVolume": "

Connects a volume to an iSCSI connection and then attaches the volume to the specified gateway. Detaching and attaching a volume enables you to recover your data from one gateway to a different gateway without creating a snapshot. It also makes it easier to move your volumes from an on-premises gateway to a gateway hosted on an Amazon EC2 instance.

", "CancelArchival": "

Cancels archiving of a virtual tape to the virtual tape shelf (VTS) after the archiving process is initiated. This operation is only supported in the tape gateway type.

", "CancelRetrieval": "

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS. This operation is only supported in the tape gateway type.

", @@ -131,6 +132,16 @@ "refs": { } }, + "AssignTapePoolInput": { + "base": null, + "refs": { + } + }, + "AssignTapePoolOutput": { + "base": null, + "refs": { + } + }, "AttachVolumeInput": { "base": "

AttachVolumeInput

", "refs": { @@ -1335,6 +1346,7 @@ "PoolId": { "base": null, "refs": { + "AssignTapePoolInput$PoolId": "

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 (Glacier or Deep Archive) that corresponds to the pool.

Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

", "CreateTapeWithBarcodeInput$PoolId": "

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 (Glacier or Deep Archive) that corresponds to the pool.

Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

", "CreateTapesInput$PoolId": "

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 (Glacier or Deep Archive) that corresponds to the pool.

Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

", "Tape$PoolId": "

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 you use your backup application to eject the tape, the tape is archived directly into the storage class (Glacier or Deep Archive) that corresponds to the pool.

Valid values: \"GLACIER\", \"DEEP_ARCHIVE\"

", @@ -1613,6 +1625,8 @@ "TapeARN": { "base": null, "refs": { + "AssignTapePoolInput$TapeARN": "

The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the tape pool.

", + "AssignTapePoolOutput$TapeARN": "

The unique Amazon Resource Names (ARN) of the virtual tape that was added to the tape pool.

", "CancelArchivalInput$TapeARN": "

The Amazon Resource Name (ARN) of the virtual tape you want to cancel archiving for.

", "CancelArchivalOutput$TapeARN": "

The Amazon Resource Name (ARN) of the virtual tape for which archiving was canceled.

", "CancelRetrievalInput$TapeARN": "

The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

", diff --git a/models/apis/sts/2011-06-15/docs-2.json b/models/apis/sts/2011-06-15/docs-2.json index 640f8871fe6..626fc4cd9be 100644 --- a/models/apis/sts/2011-06-15/docs-2.json +++ b/models/apis/sts/2011-06-15/docs-2.json @@ -1,13 +1,13 @@ { "version": "2.0", - "service": "AWS Security Token Service

The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more detailed information about using this service, go to Temporary Security Credentials.

As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to STS. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the Tools for Amazon Web Services page.

For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about the Query API, go to Making Query Requests in Using IAM. For information about using security tokens with other AWS products, go to AWS Services That Work with IAM in the IAM User Guide.

If you're new to AWS and need additional technical information about a specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/.

Endpoints

By default, AWS Security Token Service (STS) is available as a global service, and all AWS STS requests go to a single endpoint at https://sts.amazonaws.com. Global requests map to the US East (N. Virginia) region. AWS recommends using Regional AWS STS endpoints instead of the global endpoint to reduce latency, build in redundancy, and increase session token validity. For more information, see Managing AWS STS in an AWS Region in the IAM User Guide.

Most AWS Regions are enabled for operations in all AWS services by default. Those Regions are automatically activated for use with AWS STS. Some Regions, such as Asia Pacific (Hong Kong), must be manually enabled. To learn more about enabling and disabling AWS Regions, see Managing AWS Regions in the AWS General Reference. When you enable these AWS Regions, they are automatically activated for use with AWS STS. You cannot activate the STS endpoint for a Region that is disabled. Tokens that are valid in all AWS Regions are longer than tokens that are valid in Regions that are enabled by default. Changing this setting might affect existing systems where you temporarily store tokens. For more information, see Managing Global Endpoint Session Tokens in the IAM User Guide.

After you activate a Region for use with AWS STS, you can direct AWS STS API calls to that Region. AWS STS recommends that you use both the setRegion and setEndpoint methods to make calls to a Regional endpoint. You can use the setRegion method alone for manually enabled Regions, such as Asia Pacific (Hong Kong). In this case, the calls are directed to the STS Regional endpoint. However, if you use the setRegion method alone for Regions enabled by default, the calls are directed to the global endpoint of https://sts.amazonaws.com.

To view the list of AWS STS endpoints and whether they are active by default, see Writing Code to Use AWS STS Regions in the IAM User Guide.

Recording API requests

STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to STS, who made the request, when it was made, and so on.

If you activate AWS STS endpoints in Regions other than the default global endpoint, then you must also turn on CloudTrail logging in those Regions. This is necessary to record any AWS STS API calls that are made in those Regions. For more information, see Turning On CloudTrail in Additional Regions in the AWS CloudTrail User Guide.

AWS Security Token Service (STS) is a global service with a single endpoint at https://sts.amazonaws.com. Calls to this endpoint are logged as calls to a global service. However, because this endpoint is physically located in the US East (N. Virginia) Region, your logs list us-east-1 as the event Region. CloudTrail does not write these logs to the US East (Ohio) Region unless you choose to include global service logs in that Region. CloudTrail writes calls to all Regional endpoints to their respective Regions. For example, calls to sts.us-east-2.amazonaws.com are published to the US East (Ohio) Region and calls to sts.eu-central-1.amazonaws.com are published to the EU (Frankfurt) Region.

To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

", + "service": "AWS Security Token Service

The AWS Security Token Service (STS) is a web service that enables you to request temporary, limited-privilege credentials for AWS Identity and Access Management (IAM) users or for users that you authenticate (federated users). This guide provides descriptions of the STS API. For more detailed information about using this service, go to Temporary Security Credentials.

For information about setting up signatures and authorization through the API, go to Signing AWS API Requests in the AWS General Reference. For general information about the Query API, go to Making Query Requests in Using IAM. For information about using security tokens with other AWS products, go to AWS Services That Work with IAM in the IAM User Guide.

If you're new to AWS and need additional technical information about a specific AWS product, you can find the product's technical documentation at http://aws.amazon.com/documentation/.

Endpoints

By default, AWS Security Token Service (STS) is available as a global service, and all AWS STS requests go to a single endpoint at https://sts.amazonaws.com. Global requests map to the US East (N. Virginia) region. AWS recommends using Regional AWS STS endpoints instead of the global endpoint to reduce latency, build in redundancy, and increase session token validity. For more information, see Managing AWS STS in an AWS Region in the IAM User Guide.

Most AWS Regions are enabled for operations in all AWS services by default. Those Regions are automatically activated for use with AWS STS. Some Regions, such as Asia Pacific (Hong Kong), must be manually enabled. To learn more about enabling and disabling AWS Regions, see Managing AWS Regions in the AWS General Reference. When you enable these AWS Regions, they are automatically activated for use with AWS STS. You cannot activate the STS endpoint for a Region that is disabled. Tokens that are valid in all AWS Regions are longer than tokens that are valid in Regions that are enabled by default. Changing this setting might affect existing systems where you temporarily store tokens. For more information, see Managing Global Endpoint Session Tokens in the IAM User Guide.

After you activate a Region for use with AWS STS, you can direct AWS STS API calls to that Region. AWS STS recommends that you provide both the Region and endpoint when you make calls to a Regional endpoint. You can provide the Region alone for manually enabled Regions, such as Asia Pacific (Hong Kong). In this case, the calls are directed to the STS Regional endpoint. However, if you provide the Region alone for Regions enabled by default, the calls are directed to the global endpoint of https://sts.amazonaws.com.

To view the list of AWS STS endpoints and whether they are active by default, see Writing Code to Use AWS STS Regions in the IAM User Guide.

Recording API requests

STS supports AWS CloudTrail, which is a service that records AWS calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine what requests were successfully made to STS, who made the request, when it was made, and so on.

If you activate AWS STS endpoints in Regions other than the default global endpoint, then you must also turn on CloudTrail logging in those Regions. This is necessary to record any AWS STS API calls that are made in those Regions. For more information, see Turning On CloudTrail in Additional Regions in the AWS CloudTrail User Guide.

AWS Security Token Service (STS) is a global service with a single endpoint at https://sts.amazonaws.com. Calls to this endpoint are logged as calls to a global service. However, because this endpoint is physically located in the US East (N. Virginia) Region, your logs list us-east-1 as the event Region. CloudTrail does not write these logs to the US East (Ohio) Region unless you choose to include global service logs in that Region. CloudTrail writes calls to all Regional endpoints to their respective Regions. For example, calls to sts.us-east-2.amazonaws.com are published to the US East (Ohio) Region and calls to sts.eu-central-1.amazonaws.com are published to the EU (Frankfurt) Region.

To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

", "operations": { - "AssumeRole": "

Returns a set of temporary security credentials that you can use to access AWS resources that you might not normally have access to. These temporary credentials consist of an access key ID, a secret access key, and a security token. Typically, you use AssumeRole within your account or for cross-account access. For a comparison of AssumeRole with other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.

You cannot use AWS account root user credentials to call AssumeRole. You must use credentials for an IAM user or an IAM role to call AssumeRole.

For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account. Then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see IAM Roles in the IAM User Guide.

By default, the temporary security credentials created by AssumeRole last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. You can provide a value 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. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.

The temporary security credentials created by AssumeRole can be used to make API calls to any AWS service with the following exception: You cannot call the AWS STS GetFederationToken or GetSessionToken API operations.

(Optional) You can pass inline or managed session policies 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. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. 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.

To assume a role from a different account, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate that access to users in the account.

A user who wants to access a role in a different account must also have permissions that are delegated from the user account administrator. The administrator must attach a policy that allows the user to call AssumeRole for the ARN of the role in the other account. If the user is in the same account as the role, then you can do either of the following:

In this case, the trust policy acts as an IAM resource-based policy. Users in the same account as the role do not need explicit permission to assume the role. For more information about trust policies and resource-based policies, see IAM Policies in the IAM User Guide.

Using MFA with AssumeRole

(Optional) You can include multi-factor authentication (MFA) information when you call AssumeRole. This is useful for cross-account scenarios to ensure that the user that assumes the role has been authenticated with an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication. If the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example.

\"Condition\": {\"Bool\": {\"aws:MultiFactorAuthPresent\": true}}

For more information, see Configuring MFA-Protected API Access in the IAM User Guide guide.

To use MFA with AssumeRole, you pass values for the SerialNumber and TokenCode parameters. The SerialNumber value identifies the user's hardware or virtual MFA device. The TokenCode is the time-based one-time password (TOTP) that the MFA device produces.

", - "AssumeRoleWithSAML": "

Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. For a comparison of AssumeRoleWithSAML with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.

The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services.

By default, the temporary security credentials created by AssumeRoleWithSAML last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. Your role session lasts for the duration that you specify, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value 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. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.

The temporary security credentials created by AssumeRoleWithSAML can be used to make API calls to any AWS service with the following exception: you cannot call the STS GetFederationToken or GetSessionToken API operations.

(Optional) You can pass inline or managed session policies 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. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. 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.

Before your application can call AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider. You must also create an IAM role that specifies this SAML provider in its trust policy.

Calling AssumeRoleWithSAML does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider.

Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail logs. The entry includes the value in the NameID element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the Persistent Identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).

For more information, see the following resources:

", - "AssumeRoleWithWebIdentity": "

Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider. Example providers include Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider.

For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the AWS SDK for iOS Developer Guide and the AWS SDK for Android Developer Guide to uniquely identify a user. You can also supply the user with a consistent identity throughout the lifetime of an application.

To learn more about Amazon Cognito, see Amazon Cognito Overview in AWS SDK for Android Developer Guide and Amazon Cognito Overview in the AWS SDK for iOS Developer Guide.

Calling AssumeRoleWithWebIdentity does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application. You also don't need to deploy server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.

The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service API operations.

By default, the temporary security credentials created by AssumeRoleWithWebIdentity last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. You can provide a value 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. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.

The temporary security credentials created by AssumeRoleWithWebIdentity can be used to make API calls to any AWS service with the following exception: you cannot call the STS GetFederationToken or GetSessionToken API operations.

(Optional) You can pass inline or managed session policies 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. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. 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.

Before your application can call AssumeRoleWithWebIdentity, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy.

Calling AssumeRoleWithWebIdentity can result in an entry in your AWS CloudTrail logs. The entry includes the Subject of the provided Web Identity Token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as suggested in the OIDC specification.

For more information about how to use web identity federation and the AssumeRoleWithWebIdentity API, see the following resources:

", + "AssumeRole": "

Returns a set of temporary security credentials that you can use to access AWS resources that you might not normally have access to. These temporary credentials consist of an access key ID, a secret access key, and a security token. Typically, you use AssumeRole within your account or for cross-account access. For a comparison of AssumeRole with other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.

You cannot use AWS account root user credentials to call AssumeRole. You must use credentials for an IAM user or an IAM role to call AssumeRole.

For cross-account access, imagine that you own multiple accounts and need to access resources in each account. You could create long-term credentials in each account to access those resources. However, managing all those credentials and remembering which one can access which account can be time consuming. Instead, you can create one set of long-term credentials in one account. Then use temporary security credentials to access all the other accounts by assuming roles in those accounts. For more information about roles, see IAM Roles in the IAM User Guide.

By default, the temporary security credentials created by AssumeRole last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. You can provide a value 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. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.

The temporary security credentials created by AssumeRole can be used to make API calls to any AWS service with the following exception: You cannot call the AWS STS GetFederationToken or GetSessionToken API operations.

(Optional) You can pass inline or managed session policies 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. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. 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.

To assume a role from a different account, your AWS account must be trusted by the role. The trust relationship is defined in the role's trust policy when the role is created. That trust policy states which accounts are allowed to delegate that access to users in the account.

A user who wants to access a role in a different account must also have permissions that are delegated from the user account administrator. The administrator must attach a policy that allows the user to call AssumeRole for the ARN of the role in the other account. If the user is in the same account as the role, then you can do either of the following:

In this case, the trust policy acts as an IAM resource-based policy. Users in the same account as the role do not need explicit permission to assume the role. For more information about trust policies and resource-based policies, see IAM Policies in the IAM User Guide.

Using MFA with AssumeRole

(Optional) You can include multi-factor authentication (MFA) information when you call AssumeRole. This is useful for cross-account scenarios to ensure that the user that assumes the role has been authenticated with an AWS MFA device. In that scenario, the trust policy of the role being assumed includes a condition that tests for MFA authentication. If the caller does not include valid MFA information, the request to assume the role is denied. The condition in a trust policy that tests for MFA authentication might look like the following example.

\"Condition\": {\"Bool\": {\"aws:MultiFactorAuthPresent\": true}}

For more information, see Configuring MFA-Protected API Access in the IAM User Guide guide.

To use MFA with AssumeRole, you pass values for the SerialNumber and TokenCode parameters. The SerialNumber value identifies the user's hardware or virtual MFA device. The TokenCode is the time-based one-time password (TOTP) that the MFA device produces.

", + "AssumeRoleWithSAML": "

Returns a set of temporary security credentials for users who have been authenticated via a SAML authentication response. This operation provides a mechanism for tying an enterprise identity store or directory to role-based AWS access without user-specific credentials or configuration. For a comparison of AssumeRoleWithSAML with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.

The temporary security credentials returned by this operation consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS services.

By default, the temporary security credentials created by AssumeRoleWithSAML last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. Your role session lasts for the duration that you specify, or until the time specified in the SAML authentication response's SessionNotOnOrAfter value, whichever is shorter. You can provide a DurationSeconds value 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. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.

The temporary security credentials created by AssumeRoleWithSAML can be used to make API calls to any AWS service with the following exception: you cannot call the STS GetFederationToken or GetSessionToken API operations.

(Optional) You can pass inline or managed session policies 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. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. 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.

Before your application can call AssumeRoleWithSAML, you must configure your SAML identity provider (IdP) to issue the claims required by AWS. Additionally, you must use AWS Identity and Access Management (IAM) to create a SAML provider entity in your AWS account that represents your identity provider. You must also create an IAM role that specifies this SAML provider in its trust policy.

Calling AssumeRoleWithSAML does not require the use of AWS security credentials. The identity of the caller is validated by using keys in the metadata document that is uploaded for the SAML provider entity for your identity provider.

Calling AssumeRoleWithSAML can result in an entry in your AWS CloudTrail logs. The entry includes the value in the NameID element of the SAML assertion. We recommend that you use a NameIDType that is not associated with any personally identifiable information (PII). For example, you could instead use the Persistent Identifier (urn:oasis:names:tc:SAML:2.0:nameid-format:persistent).

For more information, see the following resources:

", + "AssumeRoleWithWebIdentity": "

Returns a set of temporary security credentials for users who have been authenticated in a mobile or web application with a web identity provider. Example providers include Amazon Cognito, Login with Amazon, Facebook, Google, or any OpenID Connect-compatible identity provider.

For mobile applications, we recommend that you use Amazon Cognito. You can use Amazon Cognito with the AWS SDK for iOS Developer Guide and the AWS SDK for Android Developer Guide to uniquely identify a user. You can also supply the user with a consistent identity throughout the lifetime of an application.

To learn more about Amazon Cognito, see Amazon Cognito Overview in AWS SDK for Android Developer Guide and Amazon Cognito Overview in the AWS SDK for iOS Developer Guide.

Calling AssumeRoleWithWebIdentity does not require the use of AWS security credentials. Therefore, you can distribute an application (for example, on mobile devices) that requests temporary security credentials without including long-term AWS credentials in the application. You also don't need to deploy server-based proxy services that use long-term AWS credentials. Instead, the identity of the caller is validated by using a token from the web identity provider. For a comparison of AssumeRoleWithWebIdentity with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.

The temporary security credentials returned by this API consist of an access key ID, a secret access key, and a security token. Applications can use these temporary security credentials to sign calls to AWS service API operations.

By default, the temporary security credentials created by AssumeRoleWithWebIdentity last for one hour. However, you can use the optional DurationSeconds parameter to specify the duration of your session. You can provide a value 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. To learn how to view the maximum value for your role, see View the Maximum Session Duration Setting for a Role in the IAM User Guide. The maximum session duration limit applies when you use the AssumeRole* API operations or the assume-role* CLI commands. However the limit does not apply when you use those operations to create a console URL. For more information, see Using IAM Roles in the IAM User Guide.

The temporary security credentials created by AssumeRoleWithWebIdentity can be used to make API calls to any AWS service with the following exception: you cannot call the STS GetFederationToken or GetSessionToken API operations.

(Optional) You can pass inline or managed session policies 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. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. 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.

Before your application can call AssumeRoleWithWebIdentity, you must have an identity token from a supported identity provider and create a role that the application can assume. The role that your application assumes must trust the identity provider that is associated with the identity token. In other words, the identity provider must be specified in the role's trust policy.

Calling AssumeRoleWithWebIdentity can result in an entry in your AWS CloudTrail logs. The entry includes the Subject of the provided Web Identity Token. We recommend that you avoid using any personally identifiable information (PII) in this field. For example, you could instead use a GUID or a pairwise identifier, as suggested in the OIDC specification.

For more information about how to use web identity federation and the AssumeRoleWithWebIdentity API, see the following resources:

", "DecodeAuthorizationMessage": "

Decodes additional information about the authorization status of a request from an encoded message returned in response to an AWS request.

For example, if a user is not authorized to perform an operation that he or she has requested, the request returns a Client.UnauthorizedOperation response (an HTTP 403 response). Some AWS operations additionally return an encoded message that can provide details about this authorization failure.

Only certain AWS operations return an encoded authorization message. The documentation for an individual operation indicates whether that operation returns an encoded message in addition to returning an HTTP code.

The message is encoded because the details of the authorization status can constitute privileged information that the user who requested the operation should not see. To decode an authorization status message, a user must be granted permissions via an IAM policy to request the DecodeAuthorizationMessage (sts:DecodeAuthorizationMessage) action.

The decoded message includes the following type of information:

", "GetCallerIdentity": "

Returns details about the IAM identity whose credentials are used to call the API.

", - "GetFederationToken": "

Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. You must call the GetFederationToken operation using the long-term security credentials of an IAM user. As a result, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. For a comparison of GetFederationToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.

You can create a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider.

You can also call GetFederationToken using the security credentials of an AWS account root user, but we do not recommend it. Instead, we recommend that you create an IAM user for the purpose of the proxy application. Then attach a policy to the IAM user that limits federated users to only the actions and resources that they need to access. For more information, see IAM Best Practices in the IAM User Guide.

The temporary credentials are valid for the specified duration, from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The default is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS account root user credentials have a maximum duration of 3,600 seconds (1 hour).

The temporary security credentials created by GetFederationToken can be used to make API calls to any AWS service with the following exceptions:

Permissions

You must pass an inline or managed session policy 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. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters.

Though the session policy parameters are optional, if you do not pass a policy, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the Principal element of the policy. 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 in the IAM User Guide. For information about using GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker.

", + "GetFederationToken": "

Returns a set of temporary security credentials (consisting of an access key ID, a secret access key, and a security token) for a federated user. A typical use is in a proxy application that gets temporary security credentials on behalf of distributed applications inside a corporate network. You must call the GetFederationToken operation using the long-term security credentials of an IAM user. As a result, this call is appropriate in contexts where those credentials can be safely stored, usually in a server-based application. For a comparison of GetFederationToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.

You can create a mobile-based or browser-based app that can authenticate users using a web identity provider like Login with Amazon, Facebook, Google, or an OpenID Connect-compatible identity provider. In this case, we recommend that you use Amazon Cognito or AssumeRoleWithWebIdentity. For more information, see Federation Through a Web-based Identity Provider.

You can also call GetFederationToken using the security credentials of an AWS account root user, but we do not recommend it. Instead, we recommend that you create an IAM user for the purpose of the proxy application. Then attach a policy to the IAM user that limits federated users to only the actions and resources that they need to access. For more information, see IAM Best Practices in the IAM User Guide.

The temporary credentials are valid for the specified duration, from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours). The default is 43,200 seconds (12 hours). Temporary credentials that are obtained by using AWS account root user credentials have a maximum duration of 3,600 seconds (1 hour).

The temporary security credentials created by GetFederationToken can be used to make API calls to any AWS service with the following exceptions:

Permissions

You must pass an inline or managed session policy 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. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters.

Though the session policy parameters are optional, if you do not pass a policy, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the Principal element of the policy. 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 in the IAM User Guide. For information about using GetFederationToken to create temporary security credentials, see GetFederationToken—Federation Through a Custom Identity Broker.

", "GetSessionToken": "

Returns a set of temporary credentials for an AWS account or IAM user. The credentials consist of an access key ID, a secret access key, and a security token. Typically, you use GetSessionToken if you want to use MFA to protect programmatic calls to specific AWS API operations like Amazon EC2 StopInstances. MFA-enabled IAM users would need to call GetSessionToken and submit an MFA code that is associated with their MFA device. Using the temporary security credentials that are returned from the call, IAM users can then make programmatic calls to API operations that require MFA authentication. If you do not supply a correct MFA code, then the API returns an access denied error. For a comparison of GetSessionToken with the other API operations that produce temporary credentials, see Requesting Temporary Security Credentials and Comparing the AWS STS API operations in the IAM User Guide.

The GetSessionToken operation must be called by using the long-term AWS security credentials of the AWS account root user or an IAM user. Credentials that are created by IAM users are valid for the duration that you specify. This duration can range from 900 seconds (15 minutes) up to a maximum of 129,600 seconds (36 hours), with a default of 43,200 seconds (12 hours). Credentials based on account credentials can range from 900 seconds (15 minutes) up to 3,600 seconds (1 hour), with a default of 1 hour.

The temporary security credentials created by GetSessionToken can be used to make API calls to any AWS service with the following exceptions:

We recommend that you do not call GetSessionToken with AWS account root user credentials. Instead, follow our best practices by creating one or more IAM users, giving them the necessary permissions, and using IAM users for everyday interaction with AWS.

The credentials that are returned by GetSessionToken are based on permissions associated with the user whose credentials were used to call the operation. If GetSessionToken is called using AWS account root user credentials, the temporary credentials have root user permissions. Similarly, if GetSessionToken is called using the credentials of an IAM user, the temporary credentials have the same permissions as the IAM user.

For more information about using GetSessionToken to create temporary credentials, go to Temporary Credentials for Users in Untrusted Environments in the IAM User Guide.

" }, "shapes": { @@ -323,10 +323,10 @@ "policyDescriptorListType": { "base": null, "refs": { - "AssumeRoleRequest$PolicyArns": "

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 shouldn't exceed 2048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is 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.

", - "AssumeRoleWithSAMLRequest$PolicyArns": "

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 shouldn't exceed 2048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is 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.

", - "AssumeRoleWithWebIdentityRequest$PolicyArns": "

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 shouldn't exceed 2048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is 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.

", - "GetFederationTokenRequest$PolicyArns": "

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 managed session policy 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. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the Principal element of the policy.

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 in the IAM User Guide.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

" + "AssumeRoleRequest$PolicyArns": "

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 shouldn't exceed 2048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is 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.

", + "AssumeRoleWithSAMLRequest$PolicyArns": "

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 shouldn't exceed 2048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is 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.

", + "AssumeRoleWithWebIdentityRequest$PolicyArns": "

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 shouldn't exceed 2048 characters. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is 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.

", + "GetFederationTokenRequest$PolicyArns": "

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 managed session policy 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. The plain text that you use for both inline and managed session policies shouldn't exceed 2048 characters. You can provide up to 10 managed policy ARNs. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference.

This parameter is optional. However, if you do not pass any session policies, then the resulting federated user session has no permissions. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the Principal element of the policy.

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 in the IAM User Guide.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

" } }, "regionDisabledMessage": { @@ -360,10 +360,10 @@ "sessionPolicyDocumentType": { "base": null, "refs": { - "AssumeRoleRequest$Policy": "

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 in the IAM User Guide.

The plain text that you use for both inline and managed session policies shouldn't exceed 2048 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.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

", - "AssumeRoleWithSAMLRequest$Policy": "

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 in the IAM User Guide.

The plain text that you use for both inline and managed session policies shouldn't exceed 2048 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.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

", - "AssumeRoleWithWebIdentityRequest$Policy": "

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 in the IAM User Guide.

The plain text that you use for both inline and managed session policies shouldn't exceed 2048 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.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

", - "GetFederationTokenRequest$Policy": "

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 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. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the Principal element of the policy.

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 in the IAM User Guide.

The plain text that you use for both inline and managed session policies shouldn't exceed 2048 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.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

" + "AssumeRoleRequest$Policy": "

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 in the IAM User Guide.

The plain text that you use for both inline and managed session policies shouldn't exceed 2048 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.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

", + "AssumeRoleWithSAMLRequest$Policy": "

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 in the IAM User Guide.

The plain text that you use for both inline and managed session policies shouldn't exceed 2048 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.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

", + "AssumeRoleWithWebIdentityRequest$Policy": "

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 in the IAM User Guide.

The plain text that you use for both inline and managed session policies shouldn't exceed 2048 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.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

", + "GetFederationTokenRequest$Policy": "

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 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. The only exception is when the credentials are used to access a resource that has a resource-based policy that specifically references the federated user session in the Principal element of the policy.

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 in the IAM User Guide.

The plain text that you use for both inline and managed session policies shouldn't exceed 2048 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.

The characters in this parameter count towards the 2048 character session policy guideline. However, an AWS conversion compresses the session policies into a packed binary format that has a separate limit. This is the enforced limit. The PackedPolicySize response element indicates by percentage how close the policy is to the upper size limit.

" } }, "tokenCodeType": { diff --git a/models/apis/transcribe/2017-10-26/api-2.json b/models/apis/transcribe/2017-10-26/api-2.json index 6de9bab29df..cdbc87ed4d5 100644 --- a/models/apis/transcribe/2017-10-26/api-2.json +++ b/models/apis/transcribe/2017-10-26/api-2.json @@ -254,7 +254,8 @@ "ko-KR", "es-ES", "en-IN", - "hi-IN" + "hi-IN", + "ar-SA" ] }, "LimitExceededException":{ diff --git a/models/apis/waf/2015-08-24/docs-2.json b/models/apis/waf/2015-08-24/docs-2.json index 5fea2d7a46c..1ace5d323fe 100644 --- a/models/apis/waf/2015-08-24/docs-2.json +++ b/models/apis/waf/2015-08-24/docs-2.json @@ -61,7 +61,7 @@ "ListSubscribedRuleGroups": "

Returns an array of RuleGroup objects that you are subscribed to.

", "ListWebACLs": "

Returns an array of WebACLSummary objects in the response.

", "ListXssMatchSets": "

Returns an array of XssMatchSet objects.

", - "PutLoggingConfiguration": "

Associates a LoggingConfiguration with a specified web ACL.

You can access information about all traffic that AWS WAF inspects using the following steps:

  1. Create an Amazon Kinesis Data Firehose .

    Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

  2. Associate that firehose to your web ACL using a PutLoggingConfiguration request.

When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.

", + "PutLoggingConfiguration": "

Associates a LoggingConfiguration with a specified web ACL.

You can access information about all traffic that AWS WAF inspects using the following steps:

  1. Create an Amazon Kinesis Data Firehose .

    Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

    Do not create the data firehose using a Kinesis stream as your source.

  2. Associate that firehose to your web ACL using a PutLoggingConfiguration request.

When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.

", "PutPermissionPolicy": "

Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.

The PutPermissionPolicy is subject to the following restrictions:

For more information, see IAM Policies.

An example of a valid policy parameter is shown in the Examples section below.

", "UpdateByteMatchSet": "

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:

For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

To create and configure a ByteMatchSet, perform the following steps:

  1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.

  3. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

", "UpdateGeoMatchSet": "

Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values:

To create and configure an GeoMatchSet, perform the following steps:

  1. Submit a CreateGeoMatchSet request.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request.

  3. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for.

When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

", @@ -1088,15 +1088,15 @@ "MetricName": { "base": null, "refs": { - "CreateRateBasedRuleRequest$MetricName": "

A friendly name or description for the metrics for this RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule.

", - "CreateRuleGroupRequest$MetricName": "

A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RuleGroup.

", - "CreateRuleRequest$MetricName": "

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain white space. You can't change the name of the metric after you create the Rule.

", - "CreateWebACLRequest$MetricName": "

A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain white space. You can't change MetricName after you create the WebACL.

", - "RateBasedRule$MetricName": "

A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule.

", - "Rule$MetricName": "

A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the Rule.

", - "RuleGroup$MetricName": "

A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RuleGroup.

", - "SubscribedRuleGroupSummary$MetricName": "

A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RuleGroup.

", - "WebACL$MetricName": "

A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the WebACL.

" + "CreateRateBasedRuleRequest$MetricName": "

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 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.

", + "CreateRuleGroupRequest$MetricName": "

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.

", + "CreateRuleRequest$MetricName": "

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.

", + "CreateWebACLRequest$MetricName": "

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 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 WebACL.

", + "RateBasedRule$MetricName": "

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.

", + "Rule$MetricName": "

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.

", + "RuleGroup$MetricName": "

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.

", + "SubscribedRuleGroupSummary$MetricName": "

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.

", + "WebACL$MetricName": "

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 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 WebACL.

" } }, "Negated": { diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index a5f3f9cbaed..cd685a9985f 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -3590,6 +3590,7 @@ }, "athena" : { "endpoints" : { + "us-gov-east-1" : { }, "us-gov-west-1" : { } } }, diff --git a/service/chime/api_enums.go b/service/chime/api_enums.go index 22b99c06f16..e5ab55f7cc8 100644 --- a/service/chime/api_enums.go +++ b/service/chime/api_enums.go @@ -229,6 +229,23 @@ func (enum PhoneNumberStatus) MarshalValueBuf(b []byte) ([]byte, error) { return append(b, enum...), nil } +type PhoneNumberType string + +// Enum values for PhoneNumberType +const ( + PhoneNumberTypeLocal PhoneNumberType = "Local" + PhoneNumberTypeTollFree PhoneNumberType = "TollFree" +) + +func (enum PhoneNumberType) MarshalValue() (string, error) { + return string(enum), nil +} + +func (enum PhoneNumberType) MarshalValueBuf(b []byte) ([]byte, error) { + b = b[0:0] + return append(b, enum...), nil +} + type RegistrationStatus string // Enum values for RegistrationStatus diff --git a/service/chime/api_op_BatchUpdatePhoneNumber.go b/service/chime/api_op_BatchUpdatePhoneNumber.go index 500f3e16532..78f7f71a8ba 100644 --- a/service/chime/api_op_BatchUpdatePhoneNumber.go +++ b/service/chime/api_op_BatchUpdatePhoneNumber.go @@ -103,7 +103,8 @@ const opBatchUpdatePhoneNumber = "BatchUpdatePhoneNumber" // Amazon Chime. // // Updates phone number product types. Choose from Amazon Chime Business Calling -// and Amazon Chime Voice Connector product types. +// and Amazon Chime Voice Connector product types. For toll-free numbers, you +// can use only the Amazon Chime Voice Connector product type. // // // Example sending a request using BatchUpdatePhoneNumberRequest. // req := client.BatchUpdatePhoneNumberRequest(params) diff --git a/service/chime/api_op_CreatePhoneNumberOrder.go b/service/chime/api_op_CreatePhoneNumberOrder.go index 57a8391ae7f..b18fd9a78d4 100644 --- a/service/chime/api_op_CreatePhoneNumberOrder.go +++ b/service/chime/api_op_CreatePhoneNumberOrder.go @@ -101,7 +101,9 @@ const opCreatePhoneNumberOrder = "CreatePhoneNumberOrder" // Amazon Chime. // // Creates an order for phone numbers to be provisioned. Choose from Amazon -// Chime Business Calling and Amazon Chime Voice Connector product types. +// Chime Business Calling and Amazon Chime Voice Connector product types. For +// toll-free numbers, you can use only the Amazon Chime Voice Connector product +// type. // // // Example sending a request using CreatePhoneNumberOrderRequest. // req := client.CreatePhoneNumberOrderRequest(params) diff --git a/service/chime/api_op_SearchAvailablePhoneNumbers.go b/service/chime/api_op_SearchAvailablePhoneNumbers.go index 02bdbe67135..1303eac4239 100644 --- a/service/chime/api_op_SearchAvailablePhoneNumbers.go +++ b/service/chime/api_op_SearchAvailablePhoneNumbers.go @@ -31,6 +31,9 @@ type SearchAvailablePhoneNumbersInput struct { // The state used to filter results. State *string `location:"querystring" locationName:"state" type:"string"` + + // The toll-free prefix that you use to filter results. + TollFreePrefix *string `location:"querystring" locationName:"toll-free-prefix" min:"3" type:"string"` } // String returns the string representation @@ -44,6 +47,9 @@ func (s *SearchAvailablePhoneNumbersInput) Validate() error { if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(aws.NewErrParamMinValue("MaxResults", 1)) } + if s.TollFreePrefix != nil && len(*s.TollFreePrefix) < 3 { + invalidParams.Add(aws.NewErrParamMinLen("TollFreePrefix", 3)) + } if invalidParams.Len() > 0 { return invalidParams @@ -90,6 +96,12 @@ func (s SearchAvailablePhoneNumbersInput) MarshalFields(e protocol.FieldEncoder) metadata := protocol.Metadata{} e.SetValue(protocol.QueryTarget, "state", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) } + if s.TollFreePrefix != nil { + v := *s.TollFreePrefix + + metadata := protocol.Metadata{} + e.SetValue(protocol.QueryTarget, "toll-free-prefix", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } return nil } diff --git a/service/chime/api_op_UpdatePhoneNumber.go b/service/chime/api_op_UpdatePhoneNumber.go index 4a53bc345ec..d384e799f2b 100644 --- a/service/chime/api_op_UpdatePhoneNumber.go +++ b/service/chime/api_op_UpdatePhoneNumber.go @@ -90,7 +90,8 @@ const opUpdatePhoneNumber = "UpdatePhoneNumber" // Amazon Chime. // // Updates phone number details, such as product type, for the specified phone -// number ID. +// number ID. For toll-free numbers, you can use only the Amazon Chime Voice +// Connector product type. // // // Example sending a request using UpdatePhoneNumberRequest. // req := client.UpdatePhoneNumberRequest(params) diff --git a/service/chime/api_types.go b/service/chime/api_types.go index 1cf6fa3551f..22fa565ac52 100644 --- a/service/chime/api_types.go +++ b/service/chime/api_types.go @@ -613,6 +613,9 @@ type PhoneNumber struct { // The phone number status. Status PhoneNumberStatus `type:"string" enum:"true"` + // The phone number type. + Type PhoneNumberType `type:"string" enum:"true"` + // The updated phone number timestamp, in ISO 8601 format. UpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"` } @@ -678,6 +681,12 @@ func (s PhoneNumber) MarshalFields(e protocol.FieldEncoder) error { metadata := protocol.Metadata{} e.SetValue(protocol.BodyTarget, "Status", protocol.QuotedValue{ValueMarshaler: v}, metadata) } + if len(s.Type) > 0 { + v := s.Type + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "Type", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } if s.UpdatedTimestamp != nil { v := *s.UpdatedTimestamp diff --git a/service/groundstation/api_client.go b/service/groundstation/api_client.go new file mode 100644 index 00000000000..5eb2125d1b8 --- /dev/null +++ b/service/groundstation/api_client.go @@ -0,0 +1,79 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/aws/signer/v4" + "github.com/aws/aws-sdk-go-v2/private/protocol/restjson" +) + +// Client provides the API operation methods for making requests to +// AWS Ground Station. See this package's package overview docs +// for details on the service. +// +// The client's methods are safe to use concurrently. It is not safe to +// modify mutate any of the struct's properties though. +type Client struct { + *aws.Client +} + +// Used for custom client initialization logic +var initClient func(*Client) + +// Used for custom request initialization logic +var initRequest func(*Client, *aws.Request) + +const ( + ServiceName = "AWS Ground Station" // Service's name + ServiceID = "GroundStation" // Service's identifier + EndpointsID = "groundstation" // Service's Endpoint identifier +) + +// New creates a new instance of the client from the provided Config. +// +// Example: +// // Create a client from just a config. +// svc := groundstation.New(myConfig) +func New(config aws.Config) *Client { + svc := &Client{ + Client: aws.NewClient( + config, + aws.Metadata{ + ServiceName: ServiceName, + ServiceID: ServiceID, + EndpointsID: EndpointsID, + SigningName: "groundstation", + SigningRegion: config.Region, + APIVersion: "2019-05-23", + }, + ), + } + + // Handlers + svc.Handlers.Sign.PushBackNamed(v4.SignRequestHandler) + svc.Handlers.Build.PushBackNamed(restjson.BuildHandler) + svc.Handlers.Unmarshal.PushBackNamed(restjson.UnmarshalHandler) + svc.Handlers.UnmarshalMeta.PushBackNamed(restjson.UnmarshalMetaHandler) + svc.Handlers.UnmarshalError.PushBackNamed(restjson.UnmarshalErrorHandler) + + // Run custom client initialization if present + if initClient != nil { + initClient(svc) + } + + return svc +} + +// newRequest creates a new request for a client operation and runs any +// custom request initialization. +func (c *Client) newRequest(op *aws.Operation, params, data interface{}) *aws.Request { + req := c.NewRequest(op, params, data) + + // Run custom request initialization if present + if initRequest != nil { + initRequest(c, req) + } + + return req +} diff --git a/service/groundstation/api_doc.go b/service/groundstation/api_doc.go new file mode 100644 index 00000000000..b4556bf7b2b --- /dev/null +++ b/service/groundstation/api_doc.go @@ -0,0 +1,32 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package groundstation provides the client and types for making API +// requests to AWS Ground Station. +// +// Welcome to the AWS Ground Station API Reference. AWS Ground Station is a +// fully managed service that enables you to control satellite communications, +// downlink and process satellite data, and scale your satellite operations +// efficiently and cost-effectively without having to build or manage your own +// ground station infrastructure. +// +// See https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23 for more information on this service. +// +// See groundstation package documentation for more information. +// https://docs.aws.amazon.com/sdk-for-go/api/service/groundstation/ +// +// Using the Client +// +// To use AWS Ground Station with the SDK use the New function to create +// a new service client. With that client you can make API requests to the service. +// These clients are safe to use concurrently. +// +// See the SDK's documentation for more information on how to use the SDK. +// https://docs.aws.amazon.com/sdk-for-go/api/ +// +// See aws.Config documentation for more information on configuring SDK clients. +// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config +// +// See the AWS Ground Station client for more information on +// creating client for this service. +// https://docs.aws.amazon.com/sdk-for-go/api/service/groundstation/#New +package groundstation diff --git a/service/groundstation/api_enums.go b/service/groundstation/api_enums.go new file mode 100644 index 00000000000..a7e6440ee08 --- /dev/null +++ b/service/groundstation/api_enums.go @@ -0,0 +1,175 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +type AngleUnits string + +// Enum values for AngleUnits +const ( + AngleUnitsDegreeAngle AngleUnits = "DEGREE_ANGLE" + AngleUnitsRadian AngleUnits = "RADIAN" +) + +func (enum AngleUnits) MarshalValue() (string, error) { + return string(enum), nil +} + +func (enum AngleUnits) MarshalValueBuf(b []byte) ([]byte, error) { + b = b[0:0] + return append(b, enum...), nil +} + +type BandwidthUnits string + +// Enum values for BandwidthUnits +const ( + BandwidthUnitsGhz BandwidthUnits = "GHz" + BandwidthUnitsMhz BandwidthUnits = "MHz" + BandwidthUnitsKHz BandwidthUnits = "kHz" +) + +func (enum BandwidthUnits) MarshalValue() (string, error) { + return string(enum), nil +} + +func (enum BandwidthUnits) MarshalValueBuf(b []byte) ([]byte, error) { + b = b[0:0] + return append(b, enum...), nil +} + +type ConfigCapabilityType string + +// Enum values for ConfigCapabilityType +const ( + ConfigCapabilityTypeAntennaDownlink ConfigCapabilityType = "antenna-downlink" + ConfigCapabilityTypeAntennaDownlinkDemodDecode ConfigCapabilityType = "antenna-downlink-demod-decode" + ConfigCapabilityTypeAntennaUplink ConfigCapabilityType = "antenna-uplink" + ConfigCapabilityTypeDataflowEndpoint ConfigCapabilityType = "dataflow-endpoint" + ConfigCapabilityTypeTracking ConfigCapabilityType = "tracking" + ConfigCapabilityTypeUplinkEcho ConfigCapabilityType = "uplink-echo" +) + +func (enum ConfigCapabilityType) MarshalValue() (string, error) { + return string(enum), nil +} + +func (enum ConfigCapabilityType) MarshalValueBuf(b []byte) ([]byte, error) { + b = b[0:0] + return append(b, enum...), nil +} + +type ContactStatus string + +// Enum values for ContactStatus +const ( + ContactStatusAvailable ContactStatus = "AVAILABLE" + ContactStatusAwsCancelled ContactStatus = "AWS_CANCELLED" + ContactStatusCancelled ContactStatus = "CANCELLED" + ContactStatusCompleted ContactStatus = "COMPLETED" + ContactStatusFailed ContactStatus = "FAILED" + ContactStatusFailedToSchedule ContactStatus = "FAILED_TO_SCHEDULE" + ContactStatusPass ContactStatus = "PASS" + ContactStatusPostpass ContactStatus = "POSTPASS" + ContactStatusPrepass ContactStatus = "PREPASS" + ContactStatusScheduled ContactStatus = "SCHEDULED" + ContactStatusScheduling ContactStatus = "SCHEDULING" +) + +func (enum ContactStatus) MarshalValue() (string, error) { + return string(enum), nil +} + +func (enum ContactStatus) MarshalValueBuf(b []byte) ([]byte, error) { + b = b[0:0] + return append(b, enum...), nil +} + +type Criticality string + +// Enum values for Criticality +const ( + CriticalityPreferred Criticality = "PREFERRED" + CriticalityRemoved Criticality = "REMOVED" + CriticalityRequired Criticality = "REQUIRED" +) + +func (enum Criticality) MarshalValue() (string, error) { + return string(enum), nil +} + +func (enum Criticality) MarshalValueBuf(b []byte) ([]byte, error) { + b = b[0:0] + return append(b, enum...), nil +} + +type EirpUnits string + +// Enum values for EirpUnits +const ( + EirpUnitsDBw EirpUnits = "dBW" +) + +func (enum EirpUnits) MarshalValue() (string, error) { + return string(enum), nil +} + +func (enum EirpUnits) MarshalValueBuf(b []byte) ([]byte, error) { + b = b[0:0] + return append(b, enum...), nil +} + +type EndpointStatus string + +// Enum values for EndpointStatus +const ( + EndpointStatusCreated EndpointStatus = "created" + EndpointStatusCreating EndpointStatus = "creating" + EndpointStatusDeleted EndpointStatus = "deleted" + EndpointStatusDeleting EndpointStatus = "deleting" + EndpointStatusFailed EndpointStatus = "failed" +) + +func (enum EndpointStatus) MarshalValue() (string, error) { + return string(enum), nil +} + +func (enum EndpointStatus) MarshalValueBuf(b []byte) ([]byte, error) { + b = b[0:0] + return append(b, enum...), nil +} + +type FrequencyUnits string + +// Enum values for FrequencyUnits +const ( + FrequencyUnitsGhz FrequencyUnits = "GHz" + FrequencyUnitsMhz FrequencyUnits = "MHz" + FrequencyUnitsKHz FrequencyUnits = "kHz" +) + +func (enum FrequencyUnits) MarshalValue() (string, error) { + return string(enum), nil +} + +func (enum FrequencyUnits) MarshalValueBuf(b []byte) ([]byte, error) { + b = b[0:0] + return append(b, enum...), nil +} + +type Polarization string + +// Enum values for Polarization +const ( + PolarizationLeftHand Polarization = "LEFT_HAND" + PolarizationNone Polarization = "NONE" + PolarizationRightHand Polarization = "RIGHT_HAND" +) + +func (enum Polarization) MarshalValue() (string, error) { + return string(enum), nil +} + +func (enum Polarization) MarshalValueBuf(b []byte) ([]byte, error) { + b = b[0:0] + return append(b, enum...), nil +} diff --git a/service/groundstation/api_errors.go b/service/groundstation/api_errors.go new file mode 100644 index 00000000000..4c12326b754 --- /dev/null +++ b/service/groundstation/api_errors.go @@ -0,0 +1,24 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +const ( + + // ErrCodeDependencyException for service response error code + // "DependencyException". + // + // Dependency encountered an error. + ErrCodeDependencyException = "DependencyException" + + // ErrCodeInvalidParameterException for service response error code + // "InvalidParameterException". + // + // One or more parameters are not valid. + ErrCodeInvalidParameterException = "InvalidParameterException" + + // ErrCodeResourceNotFoundException for service response error code + // "ResourceNotFoundException". + // + // Resource was not found. + ErrCodeResourceNotFoundException = "ResourceNotFoundException" +) diff --git a/service/groundstation/api_op_CancelContact.go b/service/groundstation/api_op_CancelContact.go new file mode 100644 index 00000000000..980f72eaeb9 --- /dev/null +++ b/service/groundstation/api_op_CancelContact.go @@ -0,0 +1,145 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/CancelContactRequest +type CancelContactInput struct { + _ struct{} `type:"structure"` + + // UUID of a contact. + // + // ContactId is a required field + ContactId *string `location:"uri" locationName:"contactId" type:"string" required:"true"` +} + +// String returns the string representation +func (s CancelContactInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CancelContactInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "CancelContactInput"} + + if s.ContactId == nil { + invalidParams.Add(aws.NewErrParamRequired("ContactId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s CancelContactInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.ContactId != nil { + v := *s.ContactId + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "contactId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ContactIdResponse +type CancelContactOutput struct { + _ struct{} `type:"structure"` + + // UUID of a contact. + ContactId *string `locationName:"contactId" type:"string"` +} + +// String returns the string representation +func (s CancelContactOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s CancelContactOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.ContactId != nil { + v := *s.ContactId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "contactId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +const opCancelContact = "CancelContact" + +// CancelContactRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Cancels a contact with a specified contact ID. +// +// // Example sending a request using CancelContactRequest. +// req := client.CancelContactRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/CancelContact +func (c *Client) CancelContactRequest(input *CancelContactInput) CancelContactRequest { + op := &aws.Operation{ + Name: opCancelContact, + HTTPMethod: "DELETE", + HTTPPath: "/contact/{contactId}", + } + + if input == nil { + input = &CancelContactInput{} + } + + req := c.newRequest(op, input, &CancelContactOutput{}) + return CancelContactRequest{Request: req, Input: input, Copy: c.CancelContactRequest} +} + +// CancelContactRequest is the request type for the +// CancelContact API operation. +type CancelContactRequest struct { + *aws.Request + Input *CancelContactInput + Copy func(*CancelContactInput) CancelContactRequest +} + +// Send marshals and sends the CancelContact API request. +func (r CancelContactRequest) Send(ctx context.Context) (*CancelContactResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &CancelContactResponse{ + CancelContactOutput: r.Request.Data.(*CancelContactOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// CancelContactResponse is the response type for the +// CancelContact API operation. +type CancelContactResponse struct { + *CancelContactOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// CancelContact request. +func (r *CancelContactResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_CreateConfig.go b/service/groundstation/api_op_CreateConfig.go new file mode 100644 index 00000000000..7b246d7dac6 --- /dev/null +++ b/service/groundstation/api_op_CreateConfig.go @@ -0,0 +1,203 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/CreateConfigRequest +type CreateConfigInput struct { + _ struct{} `type:"structure"` + + // Parameters of a Config. + // + // ConfigData is a required field + ConfigData *ConfigTypeData `locationName:"configData" type:"structure" required:"true"` + + // Name of a Config. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // Tags assigned to a Config. + Tags map[string]string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s CreateConfigInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateConfigInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "CreateConfigInput"} + + if s.ConfigData == nil { + invalidParams.Add(aws.NewErrParamRequired("ConfigData")) + } + + if s.Name == nil { + invalidParams.Add(aws.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(aws.NewErrParamMinLen("Name", 1)) + } + if s.ConfigData != nil { + if err := s.ConfigData.Validate(); err != nil { + invalidParams.AddNested("ConfigData", err.(aws.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s CreateConfigInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.ConfigData != nil { + v := s.ConfigData + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "configData", v, metadata) + } + if s.Name != nil { + v := *s.Name + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "name", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.Tags) > 0 { + v := s.Tags + + metadata := protocol.Metadata{} + ms0 := e.Map(protocol.BodyTarget, "tags", metadata) + ms0.Start() + for k1, v1 := range v { + ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ms0.End() + + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ConfigIdResponse +type CreateConfigOutput struct { + _ struct{} `type:"structure"` + + // ARN of a Config. + ConfigArn *string `locationName:"configArn" type:"string"` + + // UUID of a Config. + ConfigId *string `locationName:"configId" type:"string"` + + // Type of a Config. + ConfigType ConfigCapabilityType `locationName:"configType" type:"string" enum:"true"` +} + +// String returns the string representation +func (s CreateConfigOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s CreateConfigOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.ConfigArn != nil { + v := *s.ConfigArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "configArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.ConfigId != nil { + v := *s.ConfigId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "configId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.ConfigType) > 0 { + v := s.ConfigType + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "configType", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + return nil +} + +const opCreateConfig = "CreateConfig" + +// CreateConfigRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Creates a Config with the specified configData parameters. +// +// Only one type of configData can be specified. +// +// // Example sending a request using CreateConfigRequest. +// req := client.CreateConfigRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/CreateConfig +func (c *Client) CreateConfigRequest(input *CreateConfigInput) CreateConfigRequest { + op := &aws.Operation{ + Name: opCreateConfig, + HTTPMethod: "POST", + HTTPPath: "/config", + } + + if input == nil { + input = &CreateConfigInput{} + } + + req := c.newRequest(op, input, &CreateConfigOutput{}) + return CreateConfigRequest{Request: req, Input: input, Copy: c.CreateConfigRequest} +} + +// CreateConfigRequest is the request type for the +// CreateConfig API operation. +type CreateConfigRequest struct { + *aws.Request + Input *CreateConfigInput + Copy func(*CreateConfigInput) CreateConfigRequest +} + +// Send marshals and sends the CreateConfig API request. +func (r CreateConfigRequest) Send(ctx context.Context) (*CreateConfigResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &CreateConfigResponse{ + CreateConfigOutput: r.Request.Data.(*CreateConfigOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// CreateConfigResponse is the response type for the +// CreateConfig API operation. +type CreateConfigResponse struct { + *CreateConfigOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// CreateConfig request. +func (r *CreateConfigResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_CreateDataflowEndpointGroup.go b/service/groundstation/api_op_CreateDataflowEndpointGroup.go new file mode 100644 index 00000000000..e667a68d2b0 --- /dev/null +++ b/service/groundstation/api_op_CreateDataflowEndpointGroup.go @@ -0,0 +1,181 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + "fmt" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/CreateDataflowEndpointGroupRequest +type CreateDataflowEndpointGroupInput struct { + _ struct{} `type:"structure"` + + // Endpoint details of each endpoint in the dataflow endpoint group. + // + // EndpointDetails is a required field + EndpointDetails []EndpointDetails `locationName:"endpointDetails" type:"list" required:"true"` + + // Tags of a dataflow endpoint group. + Tags map[string]string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s CreateDataflowEndpointGroupInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateDataflowEndpointGroupInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "CreateDataflowEndpointGroupInput"} + + if s.EndpointDetails == nil { + invalidParams.Add(aws.NewErrParamRequired("EndpointDetails")) + } + if s.EndpointDetails != nil { + for i, v := range s.EndpointDetails { + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "EndpointDetails", i), err.(aws.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s CreateDataflowEndpointGroupInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if len(s.EndpointDetails) > 0 { + v := s.EndpointDetails + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "endpointDetails", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddFields(v1) + } + ls0.End() + + } + if len(s.Tags) > 0 { + v := s.Tags + + metadata := protocol.Metadata{} + ms0 := e.Map(protocol.BodyTarget, "tags", metadata) + ms0.Start() + for k1, v1 := range v { + ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ms0.End() + + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DataflowEndpointGroupIdResponse +type CreateDataflowEndpointGroupOutput struct { + _ struct{} `type:"structure"` + + // ID of a dataflow endpoint group. + DataflowEndpointGroupId *string `locationName:"dataflowEndpointGroupId" type:"string"` +} + +// String returns the string representation +func (s CreateDataflowEndpointGroupOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s CreateDataflowEndpointGroupOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.DataflowEndpointGroupId != nil { + v := *s.DataflowEndpointGroupId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "dataflowEndpointGroupId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +const opCreateDataflowEndpointGroup = "CreateDataflowEndpointGroup" + +// CreateDataflowEndpointGroupRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint +// objects. +// +// The name field in each endpoint is used in your mission profile DataflowEndpointConfig +// to specify which endpoints to use during a contact. +// +// When a contact uses multiple DataflowEndpointConfig objects, each Config +// must match a DataflowEndpoint in the same group. +// +// // Example sending a request using CreateDataflowEndpointGroupRequest. +// req := client.CreateDataflowEndpointGroupRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/CreateDataflowEndpointGroup +func (c *Client) CreateDataflowEndpointGroupRequest(input *CreateDataflowEndpointGroupInput) CreateDataflowEndpointGroupRequest { + op := &aws.Operation{ + Name: opCreateDataflowEndpointGroup, + HTTPMethod: "POST", + HTTPPath: "/dataflowEndpointGroup", + } + + if input == nil { + input = &CreateDataflowEndpointGroupInput{} + } + + req := c.newRequest(op, input, &CreateDataflowEndpointGroupOutput{}) + return CreateDataflowEndpointGroupRequest{Request: req, Input: input, Copy: c.CreateDataflowEndpointGroupRequest} +} + +// CreateDataflowEndpointGroupRequest is the request type for the +// CreateDataflowEndpointGroup API operation. +type CreateDataflowEndpointGroupRequest struct { + *aws.Request + Input *CreateDataflowEndpointGroupInput + Copy func(*CreateDataflowEndpointGroupInput) CreateDataflowEndpointGroupRequest +} + +// Send marshals and sends the CreateDataflowEndpointGroup API request. +func (r CreateDataflowEndpointGroupRequest) Send(ctx context.Context) (*CreateDataflowEndpointGroupResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &CreateDataflowEndpointGroupResponse{ + CreateDataflowEndpointGroupOutput: r.Request.Data.(*CreateDataflowEndpointGroupOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// CreateDataflowEndpointGroupResponse is the response type for the +// CreateDataflowEndpointGroup API operation. +type CreateDataflowEndpointGroupResponse struct { + *CreateDataflowEndpointGroupOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// CreateDataflowEndpointGroup request. +func (r *CreateDataflowEndpointGroupResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_CreateMissionProfile.go b/service/groundstation/api_op_CreateMissionProfile.go new file mode 100644 index 00000000000..e5aaf4cf4a6 --- /dev/null +++ b/service/groundstation/api_op_CreateMissionProfile.go @@ -0,0 +1,254 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/CreateMissionProfileRequest +type CreateMissionProfileInput struct { + _ struct{} `type:"structure"` + + // Amount of time after a contact ends that you’d like to receive a CloudWatch + // event indicating the pass has finished. + ContactPostPassDurationSeconds *int64 `locationName:"contactPostPassDurationSeconds" min:"1" type:"integer"` + + // Amount of time prior to contact start you’d like to receive a CloudWatch + // event indicating an upcoming pass. + ContactPrePassDurationSeconds *int64 `locationName:"contactPrePassDurationSeconds" min:"1" type:"integer"` + + // A list of lists of ARNs. Each list of ARNs is an edge, with a from Config + // and a to Config. + // + // DataflowEdges is a required field + DataflowEdges [][]string `locationName:"dataflowEdges" type:"list" required:"true"` + + // Smallest amount of time in seconds that you’d like to see for an available + // contact. AWS Ground Station will not present you with contacts shorter than + // this duration. + // + // MinimumViableContactDurationSeconds is a required field + MinimumViableContactDurationSeconds *int64 `locationName:"minimumViableContactDurationSeconds" min:"1" type:"integer" required:"true"` + + // Name of a mission profile. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // Tags assigned to a mission profile. + Tags map[string]string `locationName:"tags" type:"map"` + + // ARN of a tracking Config. + // + // TrackingConfigArn is a required field + TrackingConfigArn *string `locationName:"trackingConfigArn" type:"string" required:"true"` +} + +// String returns the string representation +func (s CreateMissionProfileInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateMissionProfileInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "CreateMissionProfileInput"} + if s.ContactPostPassDurationSeconds != nil && *s.ContactPostPassDurationSeconds < 1 { + invalidParams.Add(aws.NewErrParamMinValue("ContactPostPassDurationSeconds", 1)) + } + if s.ContactPrePassDurationSeconds != nil && *s.ContactPrePassDurationSeconds < 1 { + invalidParams.Add(aws.NewErrParamMinValue("ContactPrePassDurationSeconds", 1)) + } + + if s.DataflowEdges == nil { + invalidParams.Add(aws.NewErrParamRequired("DataflowEdges")) + } + + if s.MinimumViableContactDurationSeconds == nil { + invalidParams.Add(aws.NewErrParamRequired("MinimumViableContactDurationSeconds")) + } + if s.MinimumViableContactDurationSeconds != nil && *s.MinimumViableContactDurationSeconds < 1 { + invalidParams.Add(aws.NewErrParamMinValue("MinimumViableContactDurationSeconds", 1)) + } + + if s.Name == nil { + invalidParams.Add(aws.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(aws.NewErrParamMinLen("Name", 1)) + } + + if s.TrackingConfigArn == nil { + invalidParams.Add(aws.NewErrParamRequired("TrackingConfigArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s CreateMissionProfileInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.ContactPostPassDurationSeconds != nil { + v := *s.ContactPostPassDurationSeconds + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "contactPostPassDurationSeconds", protocol.Int64Value(v), metadata) + } + if s.ContactPrePassDurationSeconds != nil { + v := *s.ContactPrePassDurationSeconds + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "contactPrePassDurationSeconds", protocol.Int64Value(v), metadata) + } + if len(s.DataflowEdges) > 0 { + v := s.DataflowEdges + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "dataflowEdges", metadata) + ls0.Start() + for _, v1 := range v { + ls1 := ls0.List() + ls1.Start() + for _, v2 := range v1 { + ls1.ListAddValue(protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v2)}) + } + ls1.End() + } + ls0.End() + + } + if s.MinimumViableContactDurationSeconds != nil { + v := *s.MinimumViableContactDurationSeconds + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "minimumViableContactDurationSeconds", protocol.Int64Value(v), metadata) + } + if s.Name != nil { + v := *s.Name + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "name", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.Tags) > 0 { + v := s.Tags + + metadata := protocol.Metadata{} + ms0 := e.Map(protocol.BodyTarget, "tags", metadata) + ms0.Start() + for k1, v1 := range v { + ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ms0.End() + + } + if s.TrackingConfigArn != nil { + v := *s.TrackingConfigArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "trackingConfigArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/MissionProfileIdResponse +type CreateMissionProfileOutput struct { + _ struct{} `type:"structure"` + + // ID of a mission profile. + MissionProfileId *string `locationName:"missionProfileId" type:"string"` +} + +// String returns the string representation +func (s CreateMissionProfileOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s CreateMissionProfileOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.MissionProfileId != nil { + v := *s.MissionProfileId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "missionProfileId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +const opCreateMissionProfile = "CreateMissionProfile" + +// CreateMissionProfileRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Creates a mission profile. +// +// dataflowEdges is a list of lists of strings. Each lower level list of strings +// has two elements: a from ARN and a to ARN. +// +// // Example sending a request using CreateMissionProfileRequest. +// req := client.CreateMissionProfileRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/CreateMissionProfile +func (c *Client) CreateMissionProfileRequest(input *CreateMissionProfileInput) CreateMissionProfileRequest { + op := &aws.Operation{ + Name: opCreateMissionProfile, + HTTPMethod: "POST", + HTTPPath: "/missionprofile", + } + + if input == nil { + input = &CreateMissionProfileInput{} + } + + req := c.newRequest(op, input, &CreateMissionProfileOutput{}) + return CreateMissionProfileRequest{Request: req, Input: input, Copy: c.CreateMissionProfileRequest} +} + +// CreateMissionProfileRequest is the request type for the +// CreateMissionProfile API operation. +type CreateMissionProfileRequest struct { + *aws.Request + Input *CreateMissionProfileInput + Copy func(*CreateMissionProfileInput) CreateMissionProfileRequest +} + +// Send marshals and sends the CreateMissionProfile API request. +func (r CreateMissionProfileRequest) Send(ctx context.Context) (*CreateMissionProfileResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &CreateMissionProfileResponse{ + CreateMissionProfileOutput: r.Request.Data.(*CreateMissionProfileOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// CreateMissionProfileResponse is the response type for the +// CreateMissionProfile API operation. +type CreateMissionProfileResponse struct { + *CreateMissionProfileOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// CreateMissionProfile request. +func (r *CreateMissionProfileResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_DeleteConfig.go b/service/groundstation/api_op_DeleteConfig.go new file mode 100644 index 00000000000..0399e16d9e5 --- /dev/null +++ b/service/groundstation/api_op_DeleteConfig.go @@ -0,0 +1,177 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DeleteConfigRequest +type DeleteConfigInput struct { + _ struct{} `type:"structure"` + + // UUID of a Config. + // + // ConfigId is a required field + ConfigId *string `location:"uri" locationName:"configId" type:"string" required:"true"` + + // Type of a Config. + // + // ConfigType is a required field + ConfigType ConfigCapabilityType `location:"uri" locationName:"configType" type:"string" required:"true" enum:"true"` +} + +// String returns the string representation +func (s DeleteConfigInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteConfigInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "DeleteConfigInput"} + + if s.ConfigId == nil { + invalidParams.Add(aws.NewErrParamRequired("ConfigId")) + } + if len(s.ConfigType) == 0 { + invalidParams.Add(aws.NewErrParamRequired("ConfigType")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s DeleteConfigInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.ConfigId != nil { + v := *s.ConfigId + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "configId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.ConfigType) > 0 { + v := s.ConfigType + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "configType", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ConfigIdResponse +type DeleteConfigOutput struct { + _ struct{} `type:"structure"` + + // ARN of a Config. + ConfigArn *string `locationName:"configArn" type:"string"` + + // UUID of a Config. + ConfigId *string `locationName:"configId" type:"string"` + + // Type of a Config. + ConfigType ConfigCapabilityType `locationName:"configType" type:"string" enum:"true"` +} + +// String returns the string representation +func (s DeleteConfigOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s DeleteConfigOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.ConfigArn != nil { + v := *s.ConfigArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "configArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.ConfigId != nil { + v := *s.ConfigId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "configId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.ConfigType) > 0 { + v := s.ConfigType + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "configType", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + return nil +} + +const opDeleteConfig = "DeleteConfig" + +// DeleteConfigRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Deletes a Config. +// +// // Example sending a request using DeleteConfigRequest. +// req := client.DeleteConfigRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DeleteConfig +func (c *Client) DeleteConfigRequest(input *DeleteConfigInput) DeleteConfigRequest { + op := &aws.Operation{ + Name: opDeleteConfig, + HTTPMethod: "DELETE", + HTTPPath: "/config/{configType}/{configId}", + } + + if input == nil { + input = &DeleteConfigInput{} + } + + req := c.newRequest(op, input, &DeleteConfigOutput{}) + return DeleteConfigRequest{Request: req, Input: input, Copy: c.DeleteConfigRequest} +} + +// DeleteConfigRequest is the request type for the +// DeleteConfig API operation. +type DeleteConfigRequest struct { + *aws.Request + Input *DeleteConfigInput + Copy func(*DeleteConfigInput) DeleteConfigRequest +} + +// Send marshals and sends the DeleteConfig API request. +func (r DeleteConfigRequest) Send(ctx context.Context) (*DeleteConfigResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &DeleteConfigResponse{ + DeleteConfigOutput: r.Request.Data.(*DeleteConfigOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// DeleteConfigResponse is the response type for the +// DeleteConfig API operation. +type DeleteConfigResponse struct { + *DeleteConfigOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// DeleteConfig request. +func (r *DeleteConfigResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_DeleteDataflowEndpointGroup.go b/service/groundstation/api_op_DeleteDataflowEndpointGroup.go new file mode 100644 index 00000000000..13cf64a3208 --- /dev/null +++ b/service/groundstation/api_op_DeleteDataflowEndpointGroup.go @@ -0,0 +1,145 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DeleteDataflowEndpointGroupRequest +type DeleteDataflowEndpointGroupInput struct { + _ struct{} `type:"structure"` + + // ID of a dataflow endpoint group. + // + // DataflowEndpointGroupId is a required field + DataflowEndpointGroupId *string `location:"uri" locationName:"dataflowEndpointGroupId" type:"string" required:"true"` +} + +// String returns the string representation +func (s DeleteDataflowEndpointGroupInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteDataflowEndpointGroupInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "DeleteDataflowEndpointGroupInput"} + + if s.DataflowEndpointGroupId == nil { + invalidParams.Add(aws.NewErrParamRequired("DataflowEndpointGroupId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s DeleteDataflowEndpointGroupInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.DataflowEndpointGroupId != nil { + v := *s.DataflowEndpointGroupId + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "dataflowEndpointGroupId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DataflowEndpointGroupIdResponse +type DeleteDataflowEndpointGroupOutput struct { + _ struct{} `type:"structure"` + + // ID of a dataflow endpoint group. + DataflowEndpointGroupId *string `locationName:"dataflowEndpointGroupId" type:"string"` +} + +// String returns the string representation +func (s DeleteDataflowEndpointGroupOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s DeleteDataflowEndpointGroupOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.DataflowEndpointGroupId != nil { + v := *s.DataflowEndpointGroupId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "dataflowEndpointGroupId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +const opDeleteDataflowEndpointGroup = "DeleteDataflowEndpointGroup" + +// DeleteDataflowEndpointGroupRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Deletes a dataflow endpoint group. +// +// // Example sending a request using DeleteDataflowEndpointGroupRequest. +// req := client.DeleteDataflowEndpointGroupRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DeleteDataflowEndpointGroup +func (c *Client) DeleteDataflowEndpointGroupRequest(input *DeleteDataflowEndpointGroupInput) DeleteDataflowEndpointGroupRequest { + op := &aws.Operation{ + Name: opDeleteDataflowEndpointGroup, + HTTPMethod: "DELETE", + HTTPPath: "/dataflowEndpointGroup/{dataflowEndpointGroupId}", + } + + if input == nil { + input = &DeleteDataflowEndpointGroupInput{} + } + + req := c.newRequest(op, input, &DeleteDataflowEndpointGroupOutput{}) + return DeleteDataflowEndpointGroupRequest{Request: req, Input: input, Copy: c.DeleteDataflowEndpointGroupRequest} +} + +// DeleteDataflowEndpointGroupRequest is the request type for the +// DeleteDataflowEndpointGroup API operation. +type DeleteDataflowEndpointGroupRequest struct { + *aws.Request + Input *DeleteDataflowEndpointGroupInput + Copy func(*DeleteDataflowEndpointGroupInput) DeleteDataflowEndpointGroupRequest +} + +// Send marshals and sends the DeleteDataflowEndpointGroup API request. +func (r DeleteDataflowEndpointGroupRequest) Send(ctx context.Context) (*DeleteDataflowEndpointGroupResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &DeleteDataflowEndpointGroupResponse{ + DeleteDataflowEndpointGroupOutput: r.Request.Data.(*DeleteDataflowEndpointGroupOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// DeleteDataflowEndpointGroupResponse is the response type for the +// DeleteDataflowEndpointGroup API operation. +type DeleteDataflowEndpointGroupResponse struct { + *DeleteDataflowEndpointGroupOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// DeleteDataflowEndpointGroup request. +func (r *DeleteDataflowEndpointGroupResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_DeleteMissionProfile.go b/service/groundstation/api_op_DeleteMissionProfile.go new file mode 100644 index 00000000000..2d4082a33f1 --- /dev/null +++ b/service/groundstation/api_op_DeleteMissionProfile.go @@ -0,0 +1,145 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DeleteMissionProfileRequest +type DeleteMissionProfileInput struct { + _ struct{} `type:"structure"` + + // UUID of a mission profile. + // + // MissionProfileId is a required field + MissionProfileId *string `location:"uri" locationName:"missionProfileId" type:"string" required:"true"` +} + +// String returns the string representation +func (s DeleteMissionProfileInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteMissionProfileInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "DeleteMissionProfileInput"} + + if s.MissionProfileId == nil { + invalidParams.Add(aws.NewErrParamRequired("MissionProfileId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s DeleteMissionProfileInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.MissionProfileId != nil { + v := *s.MissionProfileId + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "missionProfileId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/MissionProfileIdResponse +type DeleteMissionProfileOutput struct { + _ struct{} `type:"structure"` + + // ID of a mission profile. + MissionProfileId *string `locationName:"missionProfileId" type:"string"` +} + +// String returns the string representation +func (s DeleteMissionProfileOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s DeleteMissionProfileOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.MissionProfileId != nil { + v := *s.MissionProfileId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "missionProfileId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +const opDeleteMissionProfile = "DeleteMissionProfile" + +// DeleteMissionProfileRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Deletes a mission profile. +// +// // Example sending a request using DeleteMissionProfileRequest. +// req := client.DeleteMissionProfileRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DeleteMissionProfile +func (c *Client) DeleteMissionProfileRequest(input *DeleteMissionProfileInput) DeleteMissionProfileRequest { + op := &aws.Operation{ + Name: opDeleteMissionProfile, + HTTPMethod: "DELETE", + HTTPPath: "/missionprofile/{missionProfileId}", + } + + if input == nil { + input = &DeleteMissionProfileInput{} + } + + req := c.newRequest(op, input, &DeleteMissionProfileOutput{}) + return DeleteMissionProfileRequest{Request: req, Input: input, Copy: c.DeleteMissionProfileRequest} +} + +// DeleteMissionProfileRequest is the request type for the +// DeleteMissionProfile API operation. +type DeleteMissionProfileRequest struct { + *aws.Request + Input *DeleteMissionProfileInput + Copy func(*DeleteMissionProfileInput) DeleteMissionProfileRequest +} + +// Send marshals and sends the DeleteMissionProfile API request. +func (r DeleteMissionProfileRequest) Send(ctx context.Context) (*DeleteMissionProfileResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &DeleteMissionProfileResponse{ + DeleteMissionProfileOutput: r.Request.Data.(*DeleteMissionProfileOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// DeleteMissionProfileResponse is the response type for the +// DeleteMissionProfile API operation. +type DeleteMissionProfileResponse struct { + *DeleteMissionProfileOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// DeleteMissionProfile request. +func (r *DeleteMissionProfileResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_DescribeContact.go b/service/groundstation/api_op_DescribeContact.go new file mode 100644 index 00000000000..36e9dbfdf67 --- /dev/null +++ b/service/groundstation/api_op_DescribeContact.go @@ -0,0 +1,253 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + "time" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DescribeContactRequest +type DescribeContactInput struct { + _ struct{} `type:"structure"` + + // UUID of a contact. + // + // ContactId is a required field + ContactId *string `location:"uri" locationName:"contactId" type:"string" required:"true"` +} + +// String returns the string representation +func (s DescribeContactInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeContactInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "DescribeContactInput"} + + if s.ContactId == nil { + invalidParams.Add(aws.NewErrParamRequired("ContactId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s DescribeContactInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.ContactId != nil { + v := *s.ContactId + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "contactId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DescribeContactResponse +type DescribeContactOutput struct { + _ struct{} `type:"structure"` + + // UUID of a contact. + ContactId *string `locationName:"contactId" type:"string"` + + // Status of a contact. + ContactStatus ContactStatus `locationName:"contactStatus" type:"string" enum:"true"` + + // End time of a contact. + EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"unix"` + + // Error message for a contact. + ErrorMessage *string `locationName:"errorMessage" type:"string"` + + // Ground station for a contact. + GroundStation *string `locationName:"groundStation" type:"string"` + + // Maximum elevation angle of a contact. + MaximumElevation *Elevation `locationName:"maximumElevation" type:"structure"` + + // ARN of a mission profile. + MissionProfileArn *string `locationName:"missionProfileArn" type:"string"` + + // Amount of time after a contact ends that you’d like to receive a CloudWatch + // event indicating the pass has finished. + PostPassEndTime *time.Time `locationName:"postPassEndTime" type:"timestamp" timestampFormat:"unix"` + + // Amount of time prior to contact start you’d like to receive a CloudWatch + // event indicating an upcoming pass. + PrePassStartTime *time.Time `locationName:"prePassStartTime" type:"timestamp" timestampFormat:"unix"` + + // ARN of a satellite. + SatelliteArn *string `locationName:"satelliteArn" type:"string"` + + // Start time of a contact. + StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"unix"` + + // Tags assigned to a contact. + Tags map[string]string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s DescribeContactOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s DescribeContactOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.ContactId != nil { + v := *s.ContactId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "contactId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.ContactStatus) > 0 { + v := s.ContactStatus + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "contactStatus", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + if s.EndTime != nil { + v := *s.EndTime + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "endTime", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if s.ErrorMessage != nil { + v := *s.ErrorMessage + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "errorMessage", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.GroundStation != nil { + v := *s.GroundStation + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "groundStation", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.MaximumElevation != nil { + v := s.MaximumElevation + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "maximumElevation", v, metadata) + } + if s.MissionProfileArn != nil { + v := *s.MissionProfileArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "missionProfileArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.PostPassEndTime != nil { + v := *s.PostPassEndTime + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "postPassEndTime", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if s.PrePassStartTime != nil { + v := *s.PrePassStartTime + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "prePassStartTime", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if s.SatelliteArn != nil { + v := *s.SatelliteArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "satelliteArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.StartTime != nil { + v := *s.StartTime + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "startTime", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if len(s.Tags) > 0 { + v := s.Tags + + metadata := protocol.Metadata{} + ms0 := e.Map(protocol.BodyTarget, "tags", metadata) + ms0.Start() + for k1, v1 := range v { + ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ms0.End() + + } + return nil +} + +const opDescribeContact = "DescribeContact" + +// DescribeContactRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Describes an existing contact. +// +// // Example sending a request using DescribeContactRequest. +// req := client.DescribeContactRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DescribeContact +func (c *Client) DescribeContactRequest(input *DescribeContactInput) DescribeContactRequest { + op := &aws.Operation{ + Name: opDescribeContact, + HTTPMethod: "GET", + HTTPPath: "/contact/{contactId}", + } + + if input == nil { + input = &DescribeContactInput{} + } + + req := c.newRequest(op, input, &DescribeContactOutput{}) + return DescribeContactRequest{Request: req, Input: input, Copy: c.DescribeContactRequest} +} + +// DescribeContactRequest is the request type for the +// DescribeContact API operation. +type DescribeContactRequest struct { + *aws.Request + Input *DescribeContactInput + Copy func(*DescribeContactInput) DescribeContactRequest +} + +// Send marshals and sends the DescribeContact API request. +func (r DescribeContactRequest) Send(ctx context.Context) (*DescribeContactResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &DescribeContactResponse{ + DescribeContactOutput: r.Request.Data.(*DescribeContactOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// DescribeContactResponse is the response type for the +// DescribeContact API operation. +type DescribeContactResponse struct { + *DescribeContactOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// DescribeContact request. +func (r *DescribeContactResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_GetConfig.go b/service/groundstation/api_op_GetConfig.go new file mode 100644 index 00000000000..d37fff180ca --- /dev/null +++ b/service/groundstation/api_op_GetConfig.go @@ -0,0 +1,220 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetConfigRequest +type GetConfigInput struct { + _ struct{} `type:"structure"` + + // UUID of a Config. + // + // ConfigId is a required field + ConfigId *string `location:"uri" locationName:"configId" type:"string" required:"true"` + + // Type of a Config. + // + // ConfigType is a required field + ConfigType ConfigCapabilityType `location:"uri" locationName:"configType" type:"string" required:"true" enum:"true"` +} + +// String returns the string representation +func (s GetConfigInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetConfigInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "GetConfigInput"} + + if s.ConfigId == nil { + invalidParams.Add(aws.NewErrParamRequired("ConfigId")) + } + if len(s.ConfigType) == 0 { + invalidParams.Add(aws.NewErrParamRequired("ConfigType")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s GetConfigInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.ConfigId != nil { + v := *s.ConfigId + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "configId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.ConfigType) > 0 { + v := s.ConfigType + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "configType", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetConfigResponse +type GetConfigOutput struct { + _ struct{} `type:"structure"` + + // ARN of a Config + // + // ConfigArn is a required field + ConfigArn *string `locationName:"configArn" type:"string" required:"true"` + + // Data elements in a Config. + // + // ConfigData is a required field + ConfigData *ConfigTypeData `locationName:"configData" type:"structure" required:"true"` + + // UUID of a Config. + // + // ConfigId is a required field + ConfigId *string `locationName:"configId" type:"string" required:"true"` + + // Type of a Config. + ConfigType ConfigCapabilityType `locationName:"configType" type:"string" enum:"true"` + + // Name of a Config. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` + + // Tags assigned to a Config. + Tags map[string]string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s GetConfigOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s GetConfigOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.ConfigArn != nil { + v := *s.ConfigArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "configArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.ConfigData != nil { + v := s.ConfigData + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "configData", v, metadata) + } + if s.ConfigId != nil { + v := *s.ConfigId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "configId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.ConfigType) > 0 { + v := s.ConfigType + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "configType", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + if s.Name != nil { + v := *s.Name + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "name", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.Tags) > 0 { + v := s.Tags + + metadata := protocol.Metadata{} + ms0 := e.Map(protocol.BodyTarget, "tags", metadata) + ms0.Start() + for k1, v1 := range v { + ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ms0.End() + + } + return nil +} + +const opGetConfig = "GetConfig" + +// GetConfigRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Returns Config information. +// +// Only one Config response can be returned. +// +// // Example sending a request using GetConfigRequest. +// req := client.GetConfigRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetConfig +func (c *Client) GetConfigRequest(input *GetConfigInput) GetConfigRequest { + op := &aws.Operation{ + Name: opGetConfig, + HTTPMethod: "GET", + HTTPPath: "/config/{configType}/{configId}", + } + + if input == nil { + input = &GetConfigInput{} + } + + req := c.newRequest(op, input, &GetConfigOutput{}) + return GetConfigRequest{Request: req, Input: input, Copy: c.GetConfigRequest} +} + +// GetConfigRequest is the request type for the +// GetConfig API operation. +type GetConfigRequest struct { + *aws.Request + Input *GetConfigInput + Copy func(*GetConfigInput) GetConfigRequest +} + +// Send marshals and sends the GetConfig API request. +func (r GetConfigRequest) Send(ctx context.Context) (*GetConfigResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &GetConfigResponse{ + GetConfigOutput: r.Request.Data.(*GetConfigOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// GetConfigResponse is the response type for the +// GetConfig API operation. +type GetConfigResponse struct { + *GetConfigOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// GetConfig request. +func (r *GetConfigResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_GetDataflowEndpointGroup.go b/service/groundstation/api_op_GetDataflowEndpointGroup.go new file mode 100644 index 00000000000..4c9c04b56fa --- /dev/null +++ b/service/groundstation/api_op_GetDataflowEndpointGroup.go @@ -0,0 +1,184 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetDataflowEndpointGroupRequest +type GetDataflowEndpointGroupInput struct { + _ struct{} `type:"structure"` + + // UUID of a dataflow endpoint group. + // + // DataflowEndpointGroupId is a required field + DataflowEndpointGroupId *string `location:"uri" locationName:"dataflowEndpointGroupId" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetDataflowEndpointGroupInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetDataflowEndpointGroupInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "GetDataflowEndpointGroupInput"} + + if s.DataflowEndpointGroupId == nil { + invalidParams.Add(aws.NewErrParamRequired("DataflowEndpointGroupId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s GetDataflowEndpointGroupInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.DataflowEndpointGroupId != nil { + v := *s.DataflowEndpointGroupId + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "dataflowEndpointGroupId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetDataflowEndpointGroupResponse +type GetDataflowEndpointGroupOutput struct { + _ struct{} `type:"structure"` + + // ARN of a dataflow endpoint group. + DataflowEndpointGroupArn *string `locationName:"dataflowEndpointGroupArn" type:"string"` + + // UUID of a dataflow endpoint group. + DataflowEndpointGroupId *string `locationName:"dataflowEndpointGroupId" type:"string"` + + // Details of a dataflow endpoint. + EndpointsDetails []EndpointDetails `locationName:"endpointsDetails" type:"list"` + + // Tags assigned to a dataflow endpoint group. + Tags map[string]string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s GetDataflowEndpointGroupOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s GetDataflowEndpointGroupOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.DataflowEndpointGroupArn != nil { + v := *s.DataflowEndpointGroupArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "dataflowEndpointGroupArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.DataflowEndpointGroupId != nil { + v := *s.DataflowEndpointGroupId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "dataflowEndpointGroupId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.EndpointsDetails) > 0 { + v := s.EndpointsDetails + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "endpointsDetails", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddFields(v1) + } + ls0.End() + + } + if len(s.Tags) > 0 { + v := s.Tags + + metadata := protocol.Metadata{} + ms0 := e.Map(protocol.BodyTarget, "tags", metadata) + ms0.Start() + for k1, v1 := range v { + ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ms0.End() + + } + return nil +} + +const opGetDataflowEndpointGroup = "GetDataflowEndpointGroup" + +// GetDataflowEndpointGroupRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Returns the dataflow endpoint group. +// +// // Example sending a request using GetDataflowEndpointGroupRequest. +// req := client.GetDataflowEndpointGroupRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetDataflowEndpointGroup +func (c *Client) GetDataflowEndpointGroupRequest(input *GetDataflowEndpointGroupInput) GetDataflowEndpointGroupRequest { + op := &aws.Operation{ + Name: opGetDataflowEndpointGroup, + HTTPMethod: "GET", + HTTPPath: "/dataflowEndpointGroup/{dataflowEndpointGroupId}", + } + + if input == nil { + input = &GetDataflowEndpointGroupInput{} + } + + req := c.newRequest(op, input, &GetDataflowEndpointGroupOutput{}) + return GetDataflowEndpointGroupRequest{Request: req, Input: input, Copy: c.GetDataflowEndpointGroupRequest} +} + +// GetDataflowEndpointGroupRequest is the request type for the +// GetDataflowEndpointGroup API operation. +type GetDataflowEndpointGroupRequest struct { + *aws.Request + Input *GetDataflowEndpointGroupInput + Copy func(*GetDataflowEndpointGroupInput) GetDataflowEndpointGroupRequest +} + +// Send marshals and sends the GetDataflowEndpointGroup API request. +func (r GetDataflowEndpointGroupRequest) Send(ctx context.Context) (*GetDataflowEndpointGroupResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &GetDataflowEndpointGroupResponse{ + GetDataflowEndpointGroupOutput: r.Request.Data.(*GetDataflowEndpointGroupOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// GetDataflowEndpointGroupResponse is the response type for the +// GetDataflowEndpointGroup API operation. +type GetDataflowEndpointGroupResponse struct { + *GetDataflowEndpointGroupOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// GetDataflowEndpointGroup request. +func (r *GetDataflowEndpointGroupResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_GetMinuteUsage.go b/service/groundstation/api_op_GetMinuteUsage.go new file mode 100644 index 00000000000..b2cd0c24f6a --- /dev/null +++ b/service/groundstation/api_op_GetMinuteUsage.go @@ -0,0 +1,198 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetMinuteUsageRequest +type GetMinuteUsageInput struct { + _ struct{} `type:"structure"` + + // The month being requested, with a value of 1-12. + // + // Month is a required field + Month *int64 `locationName:"month" type:"integer" required:"true"` + + // The year being requested, in the format of YYYY. + // + // Year is a required field + Year *int64 `locationName:"year" type:"integer" required:"true"` +} + +// String returns the string representation +func (s GetMinuteUsageInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetMinuteUsageInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "GetMinuteUsageInput"} + + if s.Month == nil { + invalidParams.Add(aws.NewErrParamRequired("Month")) + } + + if s.Year == nil { + invalidParams.Add(aws.NewErrParamRequired("Year")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s GetMinuteUsageInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.Month != nil { + v := *s.Month + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "month", protocol.Int64Value(v), metadata) + } + if s.Year != nil { + v := *s.Year + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "year", protocol.Int64Value(v), metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetMinuteUsageResponse +type GetMinuteUsageOutput struct { + _ struct{} `type:"structure"` + + // Estimated number of minutes remaining for an account, specific to the month + // being requested. + EstimatedMinutesRemaining *int64 `locationName:"estimatedMinutesRemaining" type:"integer"` + + // Returns whether or not an account has signed up for the reserved minutes + // pricing plan, specific to the month being requested. + IsReservedMinutesCustomer *bool `locationName:"isReservedMinutesCustomer" type:"boolean"` + + // Total number of reserved minutes allocated, specific to the month being requested. + TotalReservedMinuteAllocation *int64 `locationName:"totalReservedMinuteAllocation" type:"integer"` + + // Total scheduled minutes for an account, specific to the month being requested. + TotalScheduledMinutes *int64 `locationName:"totalScheduledMinutes" type:"integer"` + + // Upcoming minutes scheduled for an account, specific to the month being requested. + UpcomingMinutesScheduled *int64 `locationName:"upcomingMinutesScheduled" type:"integer"` +} + +// String returns the string representation +func (s GetMinuteUsageOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s GetMinuteUsageOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.EstimatedMinutesRemaining != nil { + v := *s.EstimatedMinutesRemaining + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "estimatedMinutesRemaining", protocol.Int64Value(v), metadata) + } + if s.IsReservedMinutesCustomer != nil { + v := *s.IsReservedMinutesCustomer + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "isReservedMinutesCustomer", protocol.BoolValue(v), metadata) + } + if s.TotalReservedMinuteAllocation != nil { + v := *s.TotalReservedMinuteAllocation + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "totalReservedMinuteAllocation", protocol.Int64Value(v), metadata) + } + if s.TotalScheduledMinutes != nil { + v := *s.TotalScheduledMinutes + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "totalScheduledMinutes", protocol.Int64Value(v), metadata) + } + if s.UpcomingMinutesScheduled != nil { + v := *s.UpcomingMinutesScheduled + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "upcomingMinutesScheduled", protocol.Int64Value(v), metadata) + } + return nil +} + +const opGetMinuteUsage = "GetMinuteUsage" + +// GetMinuteUsageRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Returns the number of minutes used by account. +// +// // Example sending a request using GetMinuteUsageRequest. +// req := client.GetMinuteUsageRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetMinuteUsage +func (c *Client) GetMinuteUsageRequest(input *GetMinuteUsageInput) GetMinuteUsageRequest { + op := &aws.Operation{ + Name: opGetMinuteUsage, + HTTPMethod: "POST", + HTTPPath: "/minute-usage", + } + + if input == nil { + input = &GetMinuteUsageInput{} + } + + req := c.newRequest(op, input, &GetMinuteUsageOutput{}) + return GetMinuteUsageRequest{Request: req, Input: input, Copy: c.GetMinuteUsageRequest} +} + +// GetMinuteUsageRequest is the request type for the +// GetMinuteUsage API operation. +type GetMinuteUsageRequest struct { + *aws.Request + Input *GetMinuteUsageInput + Copy func(*GetMinuteUsageInput) GetMinuteUsageRequest +} + +// Send marshals and sends the GetMinuteUsage API request. +func (r GetMinuteUsageRequest) Send(ctx context.Context) (*GetMinuteUsageResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &GetMinuteUsageResponse{ + GetMinuteUsageOutput: r.Request.Data.(*GetMinuteUsageOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// GetMinuteUsageResponse is the response type for the +// GetMinuteUsage API operation. +type GetMinuteUsageResponse struct { + *GetMinuteUsageOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// GetMinuteUsage request. +func (r *GetMinuteUsageResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_GetMissionProfile.go b/service/groundstation/api_op_GetMissionProfile.go new file mode 100644 index 00000000000..de7d5b51ed6 --- /dev/null +++ b/service/groundstation/api_op_GetMissionProfile.go @@ -0,0 +1,248 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetMissionProfileRequest +type GetMissionProfileInput struct { + _ struct{} `type:"structure"` + + // UUID of a mission profile. + // + // MissionProfileId is a required field + MissionProfileId *string `location:"uri" locationName:"missionProfileId" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetMissionProfileInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetMissionProfileInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "GetMissionProfileInput"} + + if s.MissionProfileId == nil { + invalidParams.Add(aws.NewErrParamRequired("MissionProfileId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s GetMissionProfileInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.MissionProfileId != nil { + v := *s.MissionProfileId + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "missionProfileId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetMissionProfileResponse +type GetMissionProfileOutput struct { + _ struct{} `type:"structure"` + + // Amount of time after a contact ends that you’d like to receive a CloudWatch + // event indicating the pass has finished. + ContactPostPassDurationSeconds *int64 `locationName:"contactPostPassDurationSeconds" min:"1" type:"integer"` + + // Amount of time prior to contact start you’d like to receive a CloudWatch + // event indicating an upcoming pass. + ContactPrePassDurationSeconds *int64 `locationName:"contactPrePassDurationSeconds" min:"1" type:"integer"` + + // A list of lists of ARNs. Each list of ARNs is an edge, with a from Config + // and a to Config. + DataflowEdges [][]string `locationName:"dataflowEdges" type:"list"` + + // Smallest amount of time in seconds that you’d like to see for an available + // contact. AWS Ground Station will not present you with contacts shorter than + // this duration. + MinimumViableContactDurationSeconds *int64 `locationName:"minimumViableContactDurationSeconds" min:"1" type:"integer"` + + // ARN of a mission profile. + MissionProfileArn *string `locationName:"missionProfileArn" type:"string"` + + // ID of a mission profile. + MissionProfileId *string `locationName:"missionProfileId" type:"string"` + + // Name of a mission profile. + Name *string `locationName:"name" type:"string"` + + // Region of a mission profile. + Region *string `locationName:"region" type:"string"` + + // Tags assigned to a mission profile. + Tags map[string]string `locationName:"tags" type:"map"` + + // ARN of a tracking Config. + TrackingConfigArn *string `locationName:"trackingConfigArn" type:"string"` +} + +// String returns the string representation +func (s GetMissionProfileOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s GetMissionProfileOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.ContactPostPassDurationSeconds != nil { + v := *s.ContactPostPassDurationSeconds + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "contactPostPassDurationSeconds", protocol.Int64Value(v), metadata) + } + if s.ContactPrePassDurationSeconds != nil { + v := *s.ContactPrePassDurationSeconds + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "contactPrePassDurationSeconds", protocol.Int64Value(v), metadata) + } + if len(s.DataflowEdges) > 0 { + v := s.DataflowEdges + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "dataflowEdges", metadata) + ls0.Start() + for _, v1 := range v { + ls1 := ls0.List() + ls1.Start() + for _, v2 := range v1 { + ls1.ListAddValue(protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v2)}) + } + ls1.End() + } + ls0.End() + + } + if s.MinimumViableContactDurationSeconds != nil { + v := *s.MinimumViableContactDurationSeconds + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "minimumViableContactDurationSeconds", protocol.Int64Value(v), metadata) + } + if s.MissionProfileArn != nil { + v := *s.MissionProfileArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "missionProfileArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.MissionProfileId != nil { + v := *s.MissionProfileId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "missionProfileId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.Name != nil { + v := *s.Name + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "name", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.Region != nil { + v := *s.Region + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "region", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.Tags) > 0 { + v := s.Tags + + metadata := protocol.Metadata{} + ms0 := e.Map(protocol.BodyTarget, "tags", metadata) + ms0.Start() + for k1, v1 := range v { + ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ms0.End() + + } + if s.TrackingConfigArn != nil { + v := *s.TrackingConfigArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "trackingConfigArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +const opGetMissionProfile = "GetMissionProfile" + +// GetMissionProfileRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Returns a mission profile. +// +// // Example sending a request using GetMissionProfileRequest. +// req := client.GetMissionProfileRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetMissionProfile +func (c *Client) GetMissionProfileRequest(input *GetMissionProfileInput) GetMissionProfileRequest { + op := &aws.Operation{ + Name: opGetMissionProfile, + HTTPMethod: "GET", + HTTPPath: "/missionprofile/{missionProfileId}", + } + + if input == nil { + input = &GetMissionProfileInput{} + } + + req := c.newRequest(op, input, &GetMissionProfileOutput{}) + return GetMissionProfileRequest{Request: req, Input: input, Copy: c.GetMissionProfileRequest} +} + +// GetMissionProfileRequest is the request type for the +// GetMissionProfile API operation. +type GetMissionProfileRequest struct { + *aws.Request + Input *GetMissionProfileInput + Copy func(*GetMissionProfileInput) GetMissionProfileRequest +} + +// Send marshals and sends the GetMissionProfile API request. +func (r GetMissionProfileRequest) Send(ctx context.Context) (*GetMissionProfileResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &GetMissionProfileResponse{ + GetMissionProfileOutput: r.Request.Data.(*GetMissionProfileOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// GetMissionProfileResponse is the response type for the +// GetMissionProfile API operation. +type GetMissionProfileResponse struct { + *GetMissionProfileOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// GetMissionProfile request. +func (r *GetMissionProfileResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_GetSatellite.go b/service/groundstation/api_op_GetSatellite.go new file mode 100644 index 00000000000..07a49388605 --- /dev/null +++ b/service/groundstation/api_op_GetSatellite.go @@ -0,0 +1,197 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + "time" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetSatelliteRequest +type GetSatelliteInput struct { + _ struct{} `type:"structure"` + + // UUID of a satellite. + // + // SatelliteId is a required field + SatelliteId *string `location:"uri" locationName:"satelliteId" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetSatelliteInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetSatelliteInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "GetSatelliteInput"} + + if s.SatelliteId == nil { + invalidParams.Add(aws.NewErrParamRequired("SatelliteId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s GetSatelliteInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.SatelliteId != nil { + v := *s.SatelliteId + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "satelliteId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetSatelliteResponse +type GetSatelliteOutput struct { + _ struct{} `type:"structure"` + + // When a satellite was created. + DateCreated *time.Time `locationName:"dateCreated" type:"timestamp" timestampFormat:"unix"` + + // When a satellite was last updated. + LastUpdated *time.Time `locationName:"lastUpdated" type:"timestamp" timestampFormat:"unix"` + + // NORAD satellite ID number. + NoradSatelliteID *int64 `locationName:"noradSatelliteID" min:"1" type:"integer"` + + // ARN of a satellite. + SatelliteArn *string `locationName:"satelliteArn" type:"string"` + + // UUID of a satellite. + SatelliteId *string `locationName:"satelliteId" min:"1" type:"string"` + + // Tags assigned to a satellite. + Tags map[string]string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s GetSatelliteOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s GetSatelliteOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.DateCreated != nil { + v := *s.DateCreated + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "dateCreated", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if s.LastUpdated != nil { + v := *s.LastUpdated + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "lastUpdated", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if s.NoradSatelliteID != nil { + v := *s.NoradSatelliteID + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "noradSatelliteID", protocol.Int64Value(v), metadata) + } + if s.SatelliteArn != nil { + v := *s.SatelliteArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "satelliteArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.SatelliteId != nil { + v := *s.SatelliteId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "satelliteId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.Tags) > 0 { + v := s.Tags + + metadata := protocol.Metadata{} + ms0 := e.Map(protocol.BodyTarget, "tags", metadata) + ms0.Start() + for k1, v1 := range v { + ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ms0.End() + + } + return nil +} + +const opGetSatellite = "GetSatellite" + +// GetSatelliteRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Returns a satellite. +// +// // Example sending a request using GetSatelliteRequest. +// req := client.GetSatelliteRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GetSatellite +func (c *Client) GetSatelliteRequest(input *GetSatelliteInput) GetSatelliteRequest { + op := &aws.Operation{ + Name: opGetSatellite, + HTTPMethod: "GET", + HTTPPath: "/satellite/{satelliteId}", + } + + if input == nil { + input = &GetSatelliteInput{} + } + + req := c.newRequest(op, input, &GetSatelliteOutput{}) + return GetSatelliteRequest{Request: req, Input: input, Copy: c.GetSatelliteRequest} +} + +// GetSatelliteRequest is the request type for the +// GetSatellite API operation. +type GetSatelliteRequest struct { + *aws.Request + Input *GetSatelliteInput + Copy func(*GetSatelliteInput) GetSatelliteRequest +} + +// Send marshals and sends the GetSatellite API request. +func (r GetSatelliteRequest) Send(ctx context.Context) (*GetSatelliteResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &GetSatelliteResponse{ + GetSatelliteOutput: r.Request.Data.(*GetSatelliteOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// GetSatelliteResponse is the response type for the +// GetSatellite API operation. +type GetSatelliteResponse struct { + *GetSatelliteOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// GetSatellite request. +func (r *GetSatelliteResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_ListConfigs.go b/service/groundstation/api_op_ListConfigs.go new file mode 100644 index 00000000000..4da12a1c9f8 --- /dev/null +++ b/service/groundstation/api_op_ListConfigs.go @@ -0,0 +1,208 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListConfigsRequest +type ListConfigsInput struct { + _ struct{} `type:"structure"` + + // Maximum number of Configs returned. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // Next token returned in the request of a previous ListConfigs call. Used to + // get the next page of results. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` +} + +// String returns the string representation +func (s ListConfigsInput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListConfigsInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.MaxResults != nil { + v := *s.MaxResults + + metadata := protocol.Metadata{} + e.SetValue(protocol.QueryTarget, "maxResults", protocol.Int64Value(v), metadata) + } + if s.NextToken != nil { + v := *s.NextToken + + metadata := protocol.Metadata{} + e.SetValue(protocol.QueryTarget, "nextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListConfigsResponse +type ListConfigsOutput struct { + _ struct{} `type:"structure"` + + // List of Config items. + ConfigList []ConfigListItem `locationName:"configList" type:"list"` + + // Next token returned in the response of a previous ListConfigs call. Used + // to get the next page of results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation +func (s ListConfigsOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListConfigsOutput) MarshalFields(e protocol.FieldEncoder) error { + if len(s.ConfigList) > 0 { + v := s.ConfigList + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "configList", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddFields(v1) + } + ls0.End() + + } + if s.NextToken != nil { + v := *s.NextToken + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "nextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +const opListConfigs = "ListConfigs" + +// ListConfigsRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Returns a list of Config objects. +// +// // Example sending a request using ListConfigsRequest. +// req := client.ListConfigsRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListConfigs +func (c *Client) ListConfigsRequest(input *ListConfigsInput) ListConfigsRequest { + op := &aws.Operation{ + Name: opListConfigs, + HTTPMethod: "GET", + HTTPPath: "/config", + Paginator: &aws.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListConfigsInput{} + } + + req := c.newRequest(op, input, &ListConfigsOutput{}) + return ListConfigsRequest{Request: req, Input: input, Copy: c.ListConfigsRequest} +} + +// ListConfigsRequest is the request type for the +// ListConfigs API operation. +type ListConfigsRequest struct { + *aws.Request + Input *ListConfigsInput + Copy func(*ListConfigsInput) ListConfigsRequest +} + +// Send marshals and sends the ListConfigs API request. +func (r ListConfigsRequest) Send(ctx context.Context) (*ListConfigsResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &ListConfigsResponse{ + ListConfigsOutput: r.Request.Data.(*ListConfigsOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// NewListConfigsRequestPaginator returns a paginator for ListConfigs. +// Use Next method to get the next page, and CurrentPage to get the current +// response page from the paginator. Next will return false, if there are +// no more pages, or an error was encountered. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over pages. +// req := client.ListConfigsRequest(input) +// p := groundstation.NewListConfigsRequestPaginator(req) +// +// for p.Next(context.TODO()) { +// page := p.CurrentPage() +// } +// +// if err := p.Err(); err != nil { +// return err +// } +// +func NewListConfigsPaginator(req ListConfigsRequest) ListConfigsPaginator { + return ListConfigsPaginator{ + Pager: aws.Pager{ + NewRequest: func(ctx context.Context) (*aws.Request, error) { + var inCpy *ListConfigsInput + if req.Input != nil { + tmp := *req.Input + inCpy = &tmp + } + + newReq := req.Copy(inCpy) + newReq.SetContext(ctx) + return newReq.Request, nil + }, + }, + } +} + +// ListConfigsPaginator is used to paginate the request. This can be done by +// calling Next and CurrentPage. +type ListConfigsPaginator struct { + aws.Pager +} + +func (p *ListConfigsPaginator) CurrentPage() *ListConfigsOutput { + return p.Pager.CurrentPage().(*ListConfigsOutput) +} + +// ListConfigsResponse is the response type for the +// ListConfigs API operation. +type ListConfigsResponse struct { + *ListConfigsOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// ListConfigs request. +func (r *ListConfigsResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_ListContacts.go b/service/groundstation/api_op_ListContacts.go new file mode 100644 index 00000000000..eae6a9771b1 --- /dev/null +++ b/service/groundstation/api_op_ListContacts.go @@ -0,0 +1,300 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + "time" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListContactsRequest +type ListContactsInput struct { + _ struct{} `type:"structure"` + + // End time of a contact. + // + // EndTime is a required field + EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"unix" required:"true"` + + // Name of a ground station. + GroundStation *string `locationName:"groundStation" type:"string"` + + // Maximum number of contacts returned. + MaxResults *int64 `locationName:"maxResults" type:"integer"` + + // ARN of a mission profile. + MissionProfileArn *string `locationName:"missionProfileArn" type:"string"` + + // Next token returned in the request of a previous ListContacts call. Used + // to get the next page of results. + NextToken *string `locationName:"nextToken" type:"string"` + + // ARN of a satellite. + SatelliteArn *string `locationName:"satelliteArn" type:"string"` + + // Start time of a contact. + // + // StartTime is a required field + StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"unix" required:"true"` + + // Status of a contact reservation. + // + // StatusList is a required field + StatusList []ContactStatus `locationName:"statusList" type:"list" required:"true"` +} + +// String returns the string representation +func (s ListContactsInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListContactsInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "ListContactsInput"} + + if s.EndTime == nil { + invalidParams.Add(aws.NewErrParamRequired("EndTime")) + } + + if s.StartTime == nil { + invalidParams.Add(aws.NewErrParamRequired("StartTime")) + } + + if s.StatusList == nil { + invalidParams.Add(aws.NewErrParamRequired("StatusList")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListContactsInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.EndTime != nil { + v := *s.EndTime + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "endTime", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if s.GroundStation != nil { + v := *s.GroundStation + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "groundStation", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.MaxResults != nil { + v := *s.MaxResults + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "maxResults", protocol.Int64Value(v), metadata) + } + if s.MissionProfileArn != nil { + v := *s.MissionProfileArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "missionProfileArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.NextToken != nil { + v := *s.NextToken + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "nextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.SatelliteArn != nil { + v := *s.SatelliteArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "satelliteArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.StartTime != nil { + v := *s.StartTime + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "startTime", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if len(s.StatusList) > 0 { + v := s.StatusList + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "statusList", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddValue(protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ls0.End() + + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListContactsResponse +type ListContactsOutput struct { + _ struct{} `type:"structure"` + + // List of contacts. + ContactList []ContactData `locationName:"contactList" type:"list"` + + // Next token returned in the response of a previous ListContacts call. Used + // to get the next page of results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation +func (s ListContactsOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListContactsOutput) MarshalFields(e protocol.FieldEncoder) error { + if len(s.ContactList) > 0 { + v := s.ContactList + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "contactList", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddFields(v1) + } + ls0.End() + + } + if s.NextToken != nil { + v := *s.NextToken + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "nextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +const opListContacts = "ListContacts" + +// ListContactsRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Returns a list of contacts. +// +// If statusList contains AVAILABLE, the request must include groundstation, +// missionprofileArn, and satelliteArn. +// +// // Example sending a request using ListContactsRequest. +// req := client.ListContactsRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListContacts +func (c *Client) ListContactsRequest(input *ListContactsInput) ListContactsRequest { + op := &aws.Operation{ + Name: opListContacts, + HTTPMethod: "POST", + HTTPPath: "/contacts", + Paginator: &aws.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListContactsInput{} + } + + req := c.newRequest(op, input, &ListContactsOutput{}) + return ListContactsRequest{Request: req, Input: input, Copy: c.ListContactsRequest} +} + +// ListContactsRequest is the request type for the +// ListContacts API operation. +type ListContactsRequest struct { + *aws.Request + Input *ListContactsInput + Copy func(*ListContactsInput) ListContactsRequest +} + +// Send marshals and sends the ListContacts API request. +func (r ListContactsRequest) Send(ctx context.Context) (*ListContactsResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &ListContactsResponse{ + ListContactsOutput: r.Request.Data.(*ListContactsOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// NewListContactsRequestPaginator returns a paginator for ListContacts. +// Use Next method to get the next page, and CurrentPage to get the current +// response page from the paginator. Next will return false, if there are +// no more pages, or an error was encountered. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over pages. +// req := client.ListContactsRequest(input) +// p := groundstation.NewListContactsRequestPaginator(req) +// +// for p.Next(context.TODO()) { +// page := p.CurrentPage() +// } +// +// if err := p.Err(); err != nil { +// return err +// } +// +func NewListContactsPaginator(req ListContactsRequest) ListContactsPaginator { + return ListContactsPaginator{ + Pager: aws.Pager{ + NewRequest: func(ctx context.Context) (*aws.Request, error) { + var inCpy *ListContactsInput + if req.Input != nil { + tmp := *req.Input + inCpy = &tmp + } + + newReq := req.Copy(inCpy) + newReq.SetContext(ctx) + return newReq.Request, nil + }, + }, + } +} + +// ListContactsPaginator is used to paginate the request. This can be done by +// calling Next and CurrentPage. +type ListContactsPaginator struct { + aws.Pager +} + +func (p *ListContactsPaginator) CurrentPage() *ListContactsOutput { + return p.Pager.CurrentPage().(*ListContactsOutput) +} + +// ListContactsResponse is the response type for the +// ListContacts API operation. +type ListContactsResponse struct { + *ListContactsOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// ListContacts request. +func (r *ListContactsResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_ListDataflowEndpointGroups.go b/service/groundstation/api_op_ListDataflowEndpointGroups.go new file mode 100644 index 00000000000..1d08815a0db --- /dev/null +++ b/service/groundstation/api_op_ListDataflowEndpointGroups.go @@ -0,0 +1,208 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListDataflowEndpointGroupsRequest +type ListDataflowEndpointGroupsInput struct { + _ struct{} `type:"structure"` + + // Maximum number of dataflow endpoint groups returned. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // Next token returned in the request of a previous ListDataflowEndpointGroups + // call. Used to get the next page of results. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` +} + +// String returns the string representation +func (s ListDataflowEndpointGroupsInput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListDataflowEndpointGroupsInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.MaxResults != nil { + v := *s.MaxResults + + metadata := protocol.Metadata{} + e.SetValue(protocol.QueryTarget, "maxResults", protocol.Int64Value(v), metadata) + } + if s.NextToken != nil { + v := *s.NextToken + + metadata := protocol.Metadata{} + e.SetValue(protocol.QueryTarget, "nextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListDataflowEndpointGroupsResponse +type ListDataflowEndpointGroupsOutput struct { + _ struct{} `type:"structure"` + + // A list of dataflow endpoint groups. + DataflowEndpointGroupList []DataflowEndpointListItem `locationName:"dataflowEndpointGroupList" type:"list"` + + // Next token returned in the response of a previous ListDataflowEndpointGroups + // call. Used to get the next page of results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation +func (s ListDataflowEndpointGroupsOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListDataflowEndpointGroupsOutput) MarshalFields(e protocol.FieldEncoder) error { + if len(s.DataflowEndpointGroupList) > 0 { + v := s.DataflowEndpointGroupList + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "dataflowEndpointGroupList", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddFields(v1) + } + ls0.End() + + } + if s.NextToken != nil { + v := *s.NextToken + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "nextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +const opListDataflowEndpointGroups = "ListDataflowEndpointGroups" + +// ListDataflowEndpointGroupsRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Returns a list of DataflowEndpoint groups. +// +// // Example sending a request using ListDataflowEndpointGroupsRequest. +// req := client.ListDataflowEndpointGroupsRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListDataflowEndpointGroups +func (c *Client) ListDataflowEndpointGroupsRequest(input *ListDataflowEndpointGroupsInput) ListDataflowEndpointGroupsRequest { + op := &aws.Operation{ + Name: opListDataflowEndpointGroups, + HTTPMethod: "GET", + HTTPPath: "/dataflowEndpointGroup", + Paginator: &aws.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListDataflowEndpointGroupsInput{} + } + + req := c.newRequest(op, input, &ListDataflowEndpointGroupsOutput{}) + return ListDataflowEndpointGroupsRequest{Request: req, Input: input, Copy: c.ListDataflowEndpointGroupsRequest} +} + +// ListDataflowEndpointGroupsRequest is the request type for the +// ListDataflowEndpointGroups API operation. +type ListDataflowEndpointGroupsRequest struct { + *aws.Request + Input *ListDataflowEndpointGroupsInput + Copy func(*ListDataflowEndpointGroupsInput) ListDataflowEndpointGroupsRequest +} + +// Send marshals and sends the ListDataflowEndpointGroups API request. +func (r ListDataflowEndpointGroupsRequest) Send(ctx context.Context) (*ListDataflowEndpointGroupsResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &ListDataflowEndpointGroupsResponse{ + ListDataflowEndpointGroupsOutput: r.Request.Data.(*ListDataflowEndpointGroupsOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// NewListDataflowEndpointGroupsRequestPaginator returns a paginator for ListDataflowEndpointGroups. +// Use Next method to get the next page, and CurrentPage to get the current +// response page from the paginator. Next will return false, if there are +// no more pages, or an error was encountered. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over pages. +// req := client.ListDataflowEndpointGroupsRequest(input) +// p := groundstation.NewListDataflowEndpointGroupsRequestPaginator(req) +// +// for p.Next(context.TODO()) { +// page := p.CurrentPage() +// } +// +// if err := p.Err(); err != nil { +// return err +// } +// +func NewListDataflowEndpointGroupsPaginator(req ListDataflowEndpointGroupsRequest) ListDataflowEndpointGroupsPaginator { + return ListDataflowEndpointGroupsPaginator{ + Pager: aws.Pager{ + NewRequest: func(ctx context.Context) (*aws.Request, error) { + var inCpy *ListDataflowEndpointGroupsInput + if req.Input != nil { + tmp := *req.Input + inCpy = &tmp + } + + newReq := req.Copy(inCpy) + newReq.SetContext(ctx) + return newReq.Request, nil + }, + }, + } +} + +// ListDataflowEndpointGroupsPaginator is used to paginate the request. This can be done by +// calling Next and CurrentPage. +type ListDataflowEndpointGroupsPaginator struct { + aws.Pager +} + +func (p *ListDataflowEndpointGroupsPaginator) CurrentPage() *ListDataflowEndpointGroupsOutput { + return p.Pager.CurrentPage().(*ListDataflowEndpointGroupsOutput) +} + +// ListDataflowEndpointGroupsResponse is the response type for the +// ListDataflowEndpointGroups API operation. +type ListDataflowEndpointGroupsResponse struct { + *ListDataflowEndpointGroupsOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// ListDataflowEndpointGroups request. +func (r *ListDataflowEndpointGroupsResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_ListGroundStations.go b/service/groundstation/api_op_ListGroundStations.go new file mode 100644 index 00000000000..9266ba0594a --- /dev/null +++ b/service/groundstation/api_op_ListGroundStations.go @@ -0,0 +1,208 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListGroundStationsRequest +type ListGroundStationsInput struct { + _ struct{} `type:"structure"` + + // Maximum number of ground stations returned. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // Next token that can be supplied in the next call to get the next page of + // ground stations. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` +} + +// String returns the string representation +func (s ListGroundStationsInput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListGroundStationsInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.MaxResults != nil { + v := *s.MaxResults + + metadata := protocol.Metadata{} + e.SetValue(protocol.QueryTarget, "maxResults", protocol.Int64Value(v), metadata) + } + if s.NextToken != nil { + v := *s.NextToken + + metadata := protocol.Metadata{} + e.SetValue(protocol.QueryTarget, "nextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListGroundStationsResponse +type ListGroundStationsOutput struct { + _ struct{} `type:"structure"` + + // List of ground stations. + GroundStationList []GroundStationData `locationName:"groundStationList" type:"list"` + + // Next token that can be supplied in the next call to get the next page of + // ground stations. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation +func (s ListGroundStationsOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListGroundStationsOutput) MarshalFields(e protocol.FieldEncoder) error { + if len(s.GroundStationList) > 0 { + v := s.GroundStationList + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "groundStationList", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddFields(v1) + } + ls0.End() + + } + if s.NextToken != nil { + v := *s.NextToken + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "nextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +const opListGroundStations = "ListGroundStations" + +// ListGroundStationsRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Returns a list of ground stations. +// +// // Example sending a request using ListGroundStationsRequest. +// req := client.ListGroundStationsRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListGroundStations +func (c *Client) ListGroundStationsRequest(input *ListGroundStationsInput) ListGroundStationsRequest { + op := &aws.Operation{ + Name: opListGroundStations, + HTTPMethod: "GET", + HTTPPath: "/groundstation", + Paginator: &aws.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListGroundStationsInput{} + } + + req := c.newRequest(op, input, &ListGroundStationsOutput{}) + return ListGroundStationsRequest{Request: req, Input: input, Copy: c.ListGroundStationsRequest} +} + +// ListGroundStationsRequest is the request type for the +// ListGroundStations API operation. +type ListGroundStationsRequest struct { + *aws.Request + Input *ListGroundStationsInput + Copy func(*ListGroundStationsInput) ListGroundStationsRequest +} + +// Send marshals and sends the ListGroundStations API request. +func (r ListGroundStationsRequest) Send(ctx context.Context) (*ListGroundStationsResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &ListGroundStationsResponse{ + ListGroundStationsOutput: r.Request.Data.(*ListGroundStationsOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// NewListGroundStationsRequestPaginator returns a paginator for ListGroundStations. +// Use Next method to get the next page, and CurrentPage to get the current +// response page from the paginator. Next will return false, if there are +// no more pages, or an error was encountered. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over pages. +// req := client.ListGroundStationsRequest(input) +// p := groundstation.NewListGroundStationsRequestPaginator(req) +// +// for p.Next(context.TODO()) { +// page := p.CurrentPage() +// } +// +// if err := p.Err(); err != nil { +// return err +// } +// +func NewListGroundStationsPaginator(req ListGroundStationsRequest) ListGroundStationsPaginator { + return ListGroundStationsPaginator{ + Pager: aws.Pager{ + NewRequest: func(ctx context.Context) (*aws.Request, error) { + var inCpy *ListGroundStationsInput + if req.Input != nil { + tmp := *req.Input + inCpy = &tmp + } + + newReq := req.Copy(inCpy) + newReq.SetContext(ctx) + return newReq.Request, nil + }, + }, + } +} + +// ListGroundStationsPaginator is used to paginate the request. This can be done by +// calling Next and CurrentPage. +type ListGroundStationsPaginator struct { + aws.Pager +} + +func (p *ListGroundStationsPaginator) CurrentPage() *ListGroundStationsOutput { + return p.Pager.CurrentPage().(*ListGroundStationsOutput) +} + +// ListGroundStationsResponse is the response type for the +// ListGroundStations API operation. +type ListGroundStationsResponse struct { + *ListGroundStationsOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// ListGroundStations request. +func (r *ListGroundStationsResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_ListMissionProfiles.go b/service/groundstation/api_op_ListMissionProfiles.go new file mode 100644 index 00000000000..b20c155eb39 --- /dev/null +++ b/service/groundstation/api_op_ListMissionProfiles.go @@ -0,0 +1,208 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListMissionProfilesRequest +type ListMissionProfilesInput struct { + _ struct{} `type:"structure"` + + // Maximum number of mission profiles returned. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // Next token returned in the request of a previous ListMissionProfiles call. + // Used to get the next page of results. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` +} + +// String returns the string representation +func (s ListMissionProfilesInput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListMissionProfilesInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.MaxResults != nil { + v := *s.MaxResults + + metadata := protocol.Metadata{} + e.SetValue(protocol.QueryTarget, "maxResults", protocol.Int64Value(v), metadata) + } + if s.NextToken != nil { + v := *s.NextToken + + metadata := protocol.Metadata{} + e.SetValue(protocol.QueryTarget, "nextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListMissionProfilesResponse +type ListMissionProfilesOutput struct { + _ struct{} `type:"structure"` + + // List of mission profiles + MissionProfileList []MissionProfileListItem `locationName:"missionProfileList" type:"list"` + + // Next token returned in the response of a previous ListMissionProfiles call. + // Used to get the next page of results. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation +func (s ListMissionProfilesOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListMissionProfilesOutput) MarshalFields(e protocol.FieldEncoder) error { + if len(s.MissionProfileList) > 0 { + v := s.MissionProfileList + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "missionProfileList", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddFields(v1) + } + ls0.End() + + } + if s.NextToken != nil { + v := *s.NextToken + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "nextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +const opListMissionProfiles = "ListMissionProfiles" + +// ListMissionProfilesRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Returns a list of mission profiles. +// +// // Example sending a request using ListMissionProfilesRequest. +// req := client.ListMissionProfilesRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListMissionProfiles +func (c *Client) ListMissionProfilesRequest(input *ListMissionProfilesInput) ListMissionProfilesRequest { + op := &aws.Operation{ + Name: opListMissionProfiles, + HTTPMethod: "GET", + HTTPPath: "/missionprofile", + Paginator: &aws.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListMissionProfilesInput{} + } + + req := c.newRequest(op, input, &ListMissionProfilesOutput{}) + return ListMissionProfilesRequest{Request: req, Input: input, Copy: c.ListMissionProfilesRequest} +} + +// ListMissionProfilesRequest is the request type for the +// ListMissionProfiles API operation. +type ListMissionProfilesRequest struct { + *aws.Request + Input *ListMissionProfilesInput + Copy func(*ListMissionProfilesInput) ListMissionProfilesRequest +} + +// Send marshals and sends the ListMissionProfiles API request. +func (r ListMissionProfilesRequest) Send(ctx context.Context) (*ListMissionProfilesResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &ListMissionProfilesResponse{ + ListMissionProfilesOutput: r.Request.Data.(*ListMissionProfilesOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// NewListMissionProfilesRequestPaginator returns a paginator for ListMissionProfiles. +// Use Next method to get the next page, and CurrentPage to get the current +// response page from the paginator. Next will return false, if there are +// no more pages, or an error was encountered. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over pages. +// req := client.ListMissionProfilesRequest(input) +// p := groundstation.NewListMissionProfilesRequestPaginator(req) +// +// for p.Next(context.TODO()) { +// page := p.CurrentPage() +// } +// +// if err := p.Err(); err != nil { +// return err +// } +// +func NewListMissionProfilesPaginator(req ListMissionProfilesRequest) ListMissionProfilesPaginator { + return ListMissionProfilesPaginator{ + Pager: aws.Pager{ + NewRequest: func(ctx context.Context) (*aws.Request, error) { + var inCpy *ListMissionProfilesInput + if req.Input != nil { + tmp := *req.Input + inCpy = &tmp + } + + newReq := req.Copy(inCpy) + newReq.SetContext(ctx) + return newReq.Request, nil + }, + }, + } +} + +// ListMissionProfilesPaginator is used to paginate the request. This can be done by +// calling Next and CurrentPage. +type ListMissionProfilesPaginator struct { + aws.Pager +} + +func (p *ListMissionProfilesPaginator) CurrentPage() *ListMissionProfilesOutput { + return p.Pager.CurrentPage().(*ListMissionProfilesOutput) +} + +// ListMissionProfilesResponse is the response type for the +// ListMissionProfiles API operation. +type ListMissionProfilesResponse struct { + *ListMissionProfilesOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// ListMissionProfiles request. +func (r *ListMissionProfilesResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_ListSatellites.go b/service/groundstation/api_op_ListSatellites.go new file mode 100644 index 00000000000..9f5fb37b84d --- /dev/null +++ b/service/groundstation/api_op_ListSatellites.go @@ -0,0 +1,208 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListSatellitesRequest +type ListSatellitesInput struct { + _ struct{} `type:"structure"` + + // Maximum number of satellites returned. + MaxResults *int64 `location:"querystring" locationName:"maxResults" type:"integer"` + + // Next token that can be supplied in the next call to get the next page of + // satellites. + NextToken *string `location:"querystring" locationName:"nextToken" type:"string"` +} + +// String returns the string representation +func (s ListSatellitesInput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListSatellitesInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.MaxResults != nil { + v := *s.MaxResults + + metadata := protocol.Metadata{} + e.SetValue(protocol.QueryTarget, "maxResults", protocol.Int64Value(v), metadata) + } + if s.NextToken != nil { + v := *s.NextToken + + metadata := protocol.Metadata{} + e.SetValue(protocol.QueryTarget, "nextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListSatellitesResponse +type ListSatellitesOutput struct { + _ struct{} `type:"structure"` + + // Next token that can be supplied in the next call to get the next page of + // satellites. + NextToken *string `locationName:"nextToken" type:"string"` + + // List of satellites. + Satellites []SatelliteListItem `locationName:"satellites" type:"list"` +} + +// String returns the string representation +func (s ListSatellitesOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListSatellitesOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.NextToken != nil { + v := *s.NextToken + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "nextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.Satellites) > 0 { + v := s.Satellites + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "satellites", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddFields(v1) + } + ls0.End() + + } + return nil +} + +const opListSatellites = "ListSatellites" + +// ListSatellitesRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Returns a list of satellites. +// +// // Example sending a request using ListSatellitesRequest. +// req := client.ListSatellitesRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListSatellites +func (c *Client) ListSatellitesRequest(input *ListSatellitesInput) ListSatellitesRequest { + op := &aws.Operation{ + Name: opListSatellites, + HTTPMethod: "GET", + HTTPPath: "/satellite", + Paginator: &aws.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListSatellitesInput{} + } + + req := c.newRequest(op, input, &ListSatellitesOutput{}) + return ListSatellitesRequest{Request: req, Input: input, Copy: c.ListSatellitesRequest} +} + +// ListSatellitesRequest is the request type for the +// ListSatellites API operation. +type ListSatellitesRequest struct { + *aws.Request + Input *ListSatellitesInput + Copy func(*ListSatellitesInput) ListSatellitesRequest +} + +// Send marshals and sends the ListSatellites API request. +func (r ListSatellitesRequest) Send(ctx context.Context) (*ListSatellitesResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &ListSatellitesResponse{ + ListSatellitesOutput: r.Request.Data.(*ListSatellitesOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// NewListSatellitesRequestPaginator returns a paginator for ListSatellites. +// Use Next method to get the next page, and CurrentPage to get the current +// response page from the paginator. Next will return false, if there are +// no more pages, or an error was encountered. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over pages. +// req := client.ListSatellitesRequest(input) +// p := groundstation.NewListSatellitesRequestPaginator(req) +// +// for p.Next(context.TODO()) { +// page := p.CurrentPage() +// } +// +// if err := p.Err(); err != nil { +// return err +// } +// +func NewListSatellitesPaginator(req ListSatellitesRequest) ListSatellitesPaginator { + return ListSatellitesPaginator{ + Pager: aws.Pager{ + NewRequest: func(ctx context.Context) (*aws.Request, error) { + var inCpy *ListSatellitesInput + if req.Input != nil { + tmp := *req.Input + inCpy = &tmp + } + + newReq := req.Copy(inCpy) + newReq.SetContext(ctx) + return newReq.Request, nil + }, + }, + } +} + +// ListSatellitesPaginator is used to paginate the request. This can be done by +// calling Next and CurrentPage. +type ListSatellitesPaginator struct { + aws.Pager +} + +func (p *ListSatellitesPaginator) CurrentPage() *ListSatellitesOutput { + return p.Pager.CurrentPage().(*ListSatellitesOutput) +} + +// ListSatellitesResponse is the response type for the +// ListSatellites API operation. +type ListSatellitesResponse struct { + *ListSatellitesOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// ListSatellites request. +func (r *ListSatellitesResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_ListTagsForResource.go b/service/groundstation/api_op_ListTagsForResource.go new file mode 100644 index 00000000000..27d4b969eca --- /dev/null +++ b/service/groundstation/api_op_ListTagsForResource.go @@ -0,0 +1,151 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListTagsForResourceRequest +type ListTagsForResourceInput struct { + _ struct{} `type:"structure"` + + // ARN of a resource. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` +} + +// String returns the string representation +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "ListTagsForResourceInput"} + + if s.ResourceArn == nil { + invalidParams.Add(aws.NewErrParamRequired("ResourceArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.ResourceArn != nil { + v := *s.ResourceArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "resourceArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListTagsForResourceResponse +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // Tags assigned to a resource. + Tags map[string]string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListTagsForResourceOutput) MarshalFields(e protocol.FieldEncoder) error { + if len(s.Tags) > 0 { + v := s.Tags + + metadata := protocol.Metadata{} + ms0 := e.Map(protocol.BodyTarget, "tags", metadata) + ms0.Start() + for k1, v1 := range v { + ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ms0.End() + + } + return nil +} + +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Returns a list of tags or a specified resource. +// +// // Example sending a request using ListTagsForResourceRequest. +// req := client.ListTagsForResourceRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ListTagsForResource +func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest { + op := &aws.Operation{ + Name: opListTagsForResource, + HTTPMethod: "GET", + HTTPPath: "/tags/{resourceArn}", + } + + if input == nil { + input = &ListTagsForResourceInput{} + } + + req := c.newRequest(op, input, &ListTagsForResourceOutput{}) + return ListTagsForResourceRequest{Request: req, Input: input, Copy: c.ListTagsForResourceRequest} +} + +// ListTagsForResourceRequest is the request type for the +// ListTagsForResource API operation. +type ListTagsForResourceRequest struct { + *aws.Request + Input *ListTagsForResourceInput + Copy func(*ListTagsForResourceInput) ListTagsForResourceRequest +} + +// Send marshals and sends the ListTagsForResource API request. +func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &ListTagsForResourceResponse{ + ListTagsForResourceOutput: r.Request.Data.(*ListTagsForResourceOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// ListTagsForResourceResponse is the response type for the +// ListTagsForResource API operation. +type ListTagsForResourceResponse struct { + *ListTagsForResourceOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// ListTagsForResource request. +func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_ReserveContact.go b/service/groundstation/api_op_ReserveContact.go new file mode 100644 index 00000000000..944cd3d04c0 --- /dev/null +++ b/service/groundstation/api_op_ReserveContact.go @@ -0,0 +1,221 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + "time" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ReserveContactRequest +type ReserveContactInput struct { + _ struct{} `type:"structure"` + + // End time of a contact. + // + // EndTime is a required field + EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"unix" required:"true"` + + // Name of a ground station. + // + // GroundStation is a required field + GroundStation *string `locationName:"groundStation" type:"string" required:"true"` + + // ARN of a mission profile. + // + // MissionProfileArn is a required field + MissionProfileArn *string `locationName:"missionProfileArn" type:"string" required:"true"` + + // ARN of a satellite + // + // SatelliteArn is a required field + SatelliteArn *string `locationName:"satelliteArn" type:"string" required:"true"` + + // Start time of a contact. + // + // StartTime is a required field + StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"unix" required:"true"` + + // Tags assigned to a contact. + Tags map[string]string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s ReserveContactInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ReserveContactInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "ReserveContactInput"} + + if s.EndTime == nil { + invalidParams.Add(aws.NewErrParamRequired("EndTime")) + } + + if s.GroundStation == nil { + invalidParams.Add(aws.NewErrParamRequired("GroundStation")) + } + + if s.MissionProfileArn == nil { + invalidParams.Add(aws.NewErrParamRequired("MissionProfileArn")) + } + + if s.SatelliteArn == nil { + invalidParams.Add(aws.NewErrParamRequired("SatelliteArn")) + } + + if s.StartTime == nil { + invalidParams.Add(aws.NewErrParamRequired("StartTime")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ReserveContactInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.EndTime != nil { + v := *s.EndTime + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "endTime", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if s.GroundStation != nil { + v := *s.GroundStation + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "groundStation", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.MissionProfileArn != nil { + v := *s.MissionProfileArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "missionProfileArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.SatelliteArn != nil { + v := *s.SatelliteArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "satelliteArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.StartTime != nil { + v := *s.StartTime + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "startTime", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if len(s.Tags) > 0 { + v := s.Tags + + metadata := protocol.Metadata{} + ms0 := e.Map(protocol.BodyTarget, "tags", metadata) + ms0.Start() + for k1, v1 := range v { + ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ms0.End() + + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ContactIdResponse +type ReserveContactOutput struct { + _ struct{} `type:"structure"` + + // UUID of a contact. + ContactId *string `locationName:"contactId" type:"string"` +} + +// String returns the string representation +func (s ReserveContactOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ReserveContactOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.ContactId != nil { + v := *s.ContactId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "contactId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +const opReserveContact = "ReserveContact" + +// ReserveContactRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Reserves a contact using specified parameters. +// +// // Example sending a request using ReserveContactRequest. +// req := client.ReserveContactRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ReserveContact +func (c *Client) ReserveContactRequest(input *ReserveContactInput) ReserveContactRequest { + op := &aws.Operation{ + Name: opReserveContact, + HTTPMethod: "POST", + HTTPPath: "/contact", + } + + if input == nil { + input = &ReserveContactInput{} + } + + req := c.newRequest(op, input, &ReserveContactOutput{}) + return ReserveContactRequest{Request: req, Input: input, Copy: c.ReserveContactRequest} +} + +// ReserveContactRequest is the request type for the +// ReserveContact API operation. +type ReserveContactRequest struct { + *aws.Request + Input *ReserveContactInput + Copy func(*ReserveContactInput) ReserveContactRequest +} + +// Send marshals and sends the ReserveContact API request. +func (r ReserveContactRequest) Send(ctx context.Context) (*ReserveContactResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &ReserveContactResponse{ + ReserveContactOutput: r.Request.Data.(*ReserveContactOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// ReserveContactResponse is the response type for the +// ReserveContact API operation. +type ReserveContactResponse struct { + *ReserveContactOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// ReserveContact request. +func (r *ReserveContactResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_TagResource.go b/service/groundstation/api_op_TagResource.go new file mode 100644 index 00000000000..aba4e88c03f --- /dev/null +++ b/service/groundstation/api_op_TagResource.go @@ -0,0 +1,151 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/TagResourceRequest +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // ARN of a resource tag. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` + + // Tags assigned to a resource. + Tags map[string]string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "TagResourceInput"} + + if s.ResourceArn == nil { + invalidParams.Add(aws.NewErrParamRequired("ResourceArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s TagResourceInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if len(s.Tags) > 0 { + v := s.Tags + + metadata := protocol.Metadata{} + ms0 := e.Map(protocol.BodyTarget, "tags", metadata) + ms0.Start() + for k1, v1 := range v { + ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ms0.End() + + } + if s.ResourceArn != nil { + v := *s.ResourceArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "resourceArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/TagResourceResponse +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s TagResourceOutput) MarshalFields(e protocol.FieldEncoder) error { + return nil +} + +const opTagResource = "TagResource" + +// TagResourceRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Assigns a tag to a resource. +// +// // Example sending a request using TagResourceRequest. +// req := client.TagResourceRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/TagResource +func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest { + op := &aws.Operation{ + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/tags/{resourceArn}", + } + + if input == nil { + input = &TagResourceInput{} + } + + req := c.newRequest(op, input, &TagResourceOutput{}) + return TagResourceRequest{Request: req, Input: input, Copy: c.TagResourceRequest} +} + +// TagResourceRequest is the request type for the +// TagResource API operation. +type TagResourceRequest struct { + *aws.Request + Input *TagResourceInput + Copy func(*TagResourceInput) TagResourceRequest +} + +// Send marshals and sends the TagResource API request. +func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &TagResourceResponse{ + TagResourceOutput: r.Request.Data.(*TagResourceOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// TagResourceResponse is the response type for the +// TagResource API operation. +type TagResourceResponse struct { + *TagResourceOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// TagResource request. +func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_UntagResource.go b/service/groundstation/api_op_UntagResource.go new file mode 100644 index 00000000000..804752dd05f --- /dev/null +++ b/service/groundstation/api_op_UntagResource.go @@ -0,0 +1,157 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UntagResourceRequest +type UntagResourceInput struct { + _ struct{} `type:"structure"` + + // ARN of a resource. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` + + // Keys of a resource tag. + // + // TagKeys is a required field + TagKeys []string `location:"querystring" locationName:"tagKeys" type:"list" required:"true"` +} + +// String returns the string representation +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "UntagResourceInput"} + + if s.ResourceArn == nil { + invalidParams.Add(aws.NewErrParamRequired("ResourceArn")) + } + + if s.TagKeys == nil { + invalidParams.Add(aws.NewErrParamRequired("TagKeys")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s UntagResourceInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.ResourceArn != nil { + v := *s.ResourceArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "resourceArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.TagKeys) > 0 { + v := s.TagKeys + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.QueryTarget, "tagKeys", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddValue(protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ls0.End() + + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UntagResourceResponse +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s UntagResourceOutput) MarshalFields(e protocol.FieldEncoder) error { + return nil +} + +const opUntagResource = "UntagResource" + +// UntagResourceRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Deassigns a resource tag. +// +// // Example sending a request using UntagResourceRequest. +// req := client.UntagResourceRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UntagResource +func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest { + op := &aws.Operation{ + Name: opUntagResource, + HTTPMethod: "DELETE", + HTTPPath: "/tags/{resourceArn}", + } + + if input == nil { + input = &UntagResourceInput{} + } + + req := c.newRequest(op, input, &UntagResourceOutput{}) + return UntagResourceRequest{Request: req, Input: input, Copy: c.UntagResourceRequest} +} + +// UntagResourceRequest is the request type for the +// UntagResource API operation. +type UntagResourceRequest struct { + *aws.Request + Input *UntagResourceInput + Copy func(*UntagResourceInput) UntagResourceRequest +} + +// Send marshals and sends the UntagResource API request. +func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &UntagResourceResponse{ + UntagResourceOutput: r.Request.Data.(*UntagResourceOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// UntagResourceResponse is the response type for the +// UntagResource API operation. +type UntagResourceResponse struct { + *UntagResourceOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// UntagResource request. +func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_UpdateConfig.go b/service/groundstation/api_op_UpdateConfig.go new file mode 100644 index 00000000000..b764f9d9d2e --- /dev/null +++ b/service/groundstation/api_op_UpdateConfig.go @@ -0,0 +1,218 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UpdateConfigRequest +type UpdateConfigInput struct { + _ struct{} `type:"structure"` + + // Parameters for a Config. + // + // ConfigData is a required field + ConfigData *ConfigTypeData `locationName:"configData" type:"structure" required:"true"` + + // UUID of a Config. + // + // ConfigId is a required field + ConfigId *string `location:"uri" locationName:"configId" type:"string" required:"true"` + + // Type of a Config. + // + // ConfigType is a required field + ConfigType ConfigCapabilityType `location:"uri" locationName:"configType" type:"string" required:"true" enum:"true"` + + // Name of a Config. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s UpdateConfigInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateConfigInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "UpdateConfigInput"} + + if s.ConfigData == nil { + invalidParams.Add(aws.NewErrParamRequired("ConfigData")) + } + + if s.ConfigId == nil { + invalidParams.Add(aws.NewErrParamRequired("ConfigId")) + } + if len(s.ConfigType) == 0 { + invalidParams.Add(aws.NewErrParamRequired("ConfigType")) + } + + if s.Name == nil { + invalidParams.Add(aws.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(aws.NewErrParamMinLen("Name", 1)) + } + if s.ConfigData != nil { + if err := s.ConfigData.Validate(); err != nil { + invalidParams.AddNested("ConfigData", err.(aws.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s UpdateConfigInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.ConfigData != nil { + v := s.ConfigData + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "configData", v, metadata) + } + if s.Name != nil { + v := *s.Name + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "name", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.ConfigId != nil { + v := *s.ConfigId + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "configId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.ConfigType) > 0 { + v := s.ConfigType + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "configType", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ConfigIdResponse +type UpdateConfigOutput struct { + _ struct{} `type:"structure"` + + // ARN of a Config. + ConfigArn *string `locationName:"configArn" type:"string"` + + // UUID of a Config. + ConfigId *string `locationName:"configId" type:"string"` + + // Type of a Config. + ConfigType ConfigCapabilityType `locationName:"configType" type:"string" enum:"true"` +} + +// String returns the string representation +func (s UpdateConfigOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s UpdateConfigOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.ConfigArn != nil { + v := *s.ConfigArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "configArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.ConfigId != nil { + v := *s.ConfigId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "configId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.ConfigType) > 0 { + v := s.ConfigType + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "configType", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + return nil +} + +const opUpdateConfig = "UpdateConfig" + +// UpdateConfigRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Updates the Config used when scheduling contacts. +// +// Updating a Config will not update the execution parameters for existing future +// contacts scheduled with this Config. +// +// // Example sending a request using UpdateConfigRequest. +// req := client.UpdateConfigRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UpdateConfig +func (c *Client) UpdateConfigRequest(input *UpdateConfigInput) UpdateConfigRequest { + op := &aws.Operation{ + Name: opUpdateConfig, + HTTPMethod: "PUT", + HTTPPath: "/config/{configType}/{configId}", + } + + if input == nil { + input = &UpdateConfigInput{} + } + + req := c.newRequest(op, input, &UpdateConfigOutput{}) + return UpdateConfigRequest{Request: req, Input: input, Copy: c.UpdateConfigRequest} +} + +// UpdateConfigRequest is the request type for the +// UpdateConfig API operation. +type UpdateConfigRequest struct { + *aws.Request + Input *UpdateConfigInput + Copy func(*UpdateConfigInput) UpdateConfigRequest +} + +// Send marshals and sends the UpdateConfig API request. +func (r UpdateConfigRequest) Send(ctx context.Context) (*UpdateConfigResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &UpdateConfigResponse{ + UpdateConfigOutput: r.Request.Data.(*UpdateConfigOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// UpdateConfigResponse is the response type for the +// UpdateConfig API operation. +type UpdateConfigResponse struct { + *UpdateConfigOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// UpdateConfig request. +func (r *UpdateConfigResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_op_UpdateMissionProfile.go b/service/groundstation/api_op_UpdateMissionProfile.go new file mode 100644 index 00000000000..aabfba3bf3b --- /dev/null +++ b/service/groundstation/api_op_UpdateMissionProfile.go @@ -0,0 +1,230 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UpdateMissionProfileRequest +type UpdateMissionProfileInput struct { + _ struct{} `type:"structure"` + + // Amount of time after a contact ends that you’d like to receive a CloudWatch + // event indicating the pass has finished. + ContactPostPassDurationSeconds *int64 `locationName:"contactPostPassDurationSeconds" min:"1" type:"integer"` + + // Amount of time after a contact ends that you’d like to receive a CloudWatch + // event indicating the pass has finished. + ContactPrePassDurationSeconds *int64 `locationName:"contactPrePassDurationSeconds" min:"1" type:"integer"` + + // A list of lists of ARNs. Each list of ARNs is an edge, with a from Config + // and a to Config. + DataflowEdges [][]string `locationName:"dataflowEdges" type:"list"` + + // Smallest amount of time in seconds that you’d like to see for an available + // contact. AWS Ground Station will not present you with contacts shorter than + // this duration. + MinimumViableContactDurationSeconds *int64 `locationName:"minimumViableContactDurationSeconds" min:"1" type:"integer"` + + // ID of a mission profile. + // + // MissionProfileId is a required field + MissionProfileId *string `location:"uri" locationName:"missionProfileId" type:"string" required:"true"` + + // Name of a mission profile. + Name *string `locationName:"name" min:"1" type:"string"` + + // ARN of a tracking Config. + TrackingConfigArn *string `locationName:"trackingConfigArn" type:"string"` +} + +// String returns the string representation +func (s UpdateMissionProfileInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateMissionProfileInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "UpdateMissionProfileInput"} + if s.ContactPostPassDurationSeconds != nil && *s.ContactPostPassDurationSeconds < 1 { + invalidParams.Add(aws.NewErrParamMinValue("ContactPostPassDurationSeconds", 1)) + } + if s.ContactPrePassDurationSeconds != nil && *s.ContactPrePassDurationSeconds < 1 { + invalidParams.Add(aws.NewErrParamMinValue("ContactPrePassDurationSeconds", 1)) + } + if s.MinimumViableContactDurationSeconds != nil && *s.MinimumViableContactDurationSeconds < 1 { + invalidParams.Add(aws.NewErrParamMinValue("MinimumViableContactDurationSeconds", 1)) + } + + if s.MissionProfileId == nil { + invalidParams.Add(aws.NewErrParamRequired("MissionProfileId")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(aws.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s UpdateMissionProfileInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.ContactPostPassDurationSeconds != nil { + v := *s.ContactPostPassDurationSeconds + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "contactPostPassDurationSeconds", protocol.Int64Value(v), metadata) + } + if s.ContactPrePassDurationSeconds != nil { + v := *s.ContactPrePassDurationSeconds + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "contactPrePassDurationSeconds", protocol.Int64Value(v), metadata) + } + if len(s.DataflowEdges) > 0 { + v := s.DataflowEdges + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "dataflowEdges", metadata) + ls0.Start() + for _, v1 := range v { + ls1 := ls0.List() + ls1.Start() + for _, v2 := range v1 { + ls1.ListAddValue(protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v2)}) + } + ls1.End() + } + ls0.End() + + } + if s.MinimumViableContactDurationSeconds != nil { + v := *s.MinimumViableContactDurationSeconds + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "minimumViableContactDurationSeconds", protocol.Int64Value(v), metadata) + } + if s.Name != nil { + v := *s.Name + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "name", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.TrackingConfigArn != nil { + v := *s.TrackingConfigArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "trackingConfigArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.MissionProfileId != nil { + v := *s.MissionProfileId + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "missionProfileId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/MissionProfileIdResponse +type UpdateMissionProfileOutput struct { + _ struct{} `type:"structure"` + + // ID of a mission profile. + MissionProfileId *string `locationName:"missionProfileId" type:"string"` +} + +// String returns the string representation +func (s UpdateMissionProfileOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s UpdateMissionProfileOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.MissionProfileId != nil { + v := *s.MissionProfileId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "missionProfileId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +const opUpdateMissionProfile = "UpdateMissionProfile" + +// UpdateMissionProfileRequest returns a request value for making API operation for +// AWS Ground Station. +// +// Updates a mission profile. +// +// Updating a mission profile will not update the execution parameters for existing +// future contacts. +// +// // Example sending a request using UpdateMissionProfileRequest. +// req := client.UpdateMissionProfileRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UpdateMissionProfile +func (c *Client) UpdateMissionProfileRequest(input *UpdateMissionProfileInput) UpdateMissionProfileRequest { + op := &aws.Operation{ + Name: opUpdateMissionProfile, + HTTPMethod: "PUT", + HTTPPath: "/missionprofile/{missionProfileId}", + } + + if input == nil { + input = &UpdateMissionProfileInput{} + } + + req := c.newRequest(op, input, &UpdateMissionProfileOutput{}) + return UpdateMissionProfileRequest{Request: req, Input: input, Copy: c.UpdateMissionProfileRequest} +} + +// UpdateMissionProfileRequest is the request type for the +// UpdateMissionProfile API operation. +type UpdateMissionProfileRequest struct { + *aws.Request + Input *UpdateMissionProfileInput + Copy func(*UpdateMissionProfileInput) UpdateMissionProfileRequest +} + +// Send marshals and sends the UpdateMissionProfile API request. +func (r UpdateMissionProfileRequest) Send(ctx context.Context) (*UpdateMissionProfileResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &UpdateMissionProfileResponse{ + UpdateMissionProfileOutput: r.Request.Data.(*UpdateMissionProfileOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// UpdateMissionProfileResponse is the response type for the +// UpdateMissionProfile API operation. +type UpdateMissionProfileResponse struct { + *UpdateMissionProfileOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// UpdateMissionProfile request. +func (r *UpdateMissionProfileResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/groundstation/api_types.go b/service/groundstation/api_types.go new file mode 100644 index 00000000000..26e3474e5d7 --- /dev/null +++ b/service/groundstation/api_types.go @@ -0,0 +1,1506 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package groundstation + +import ( + "time" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +var _ aws.Config +var _ = awsutil.Prettify + +// Information about how AWS Ground Station should configure an antenna for +// downlink during a contact. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/AntennaDownlinkConfig +type AntennaDownlinkConfig struct { + _ struct{} `type:"structure"` + + // Object that describes a spectral Config. + // + // SpectrumConfig is a required field + SpectrumConfig *SpectrumConfig `locationName:"spectrumConfig" type:"structure" required:"true"` +} + +// String returns the string representation +func (s AntennaDownlinkConfig) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AntennaDownlinkConfig) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "AntennaDownlinkConfig"} + + if s.SpectrumConfig == nil { + invalidParams.Add(aws.NewErrParamRequired("SpectrumConfig")) + } + if s.SpectrumConfig != nil { + if err := s.SpectrumConfig.Validate(); err != nil { + invalidParams.AddNested("SpectrumConfig", err.(aws.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s AntennaDownlinkConfig) MarshalFields(e protocol.FieldEncoder) error { + if s.SpectrumConfig != nil { + v := s.SpectrumConfig + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "spectrumConfig", v, metadata) + } + return nil +} + +// Information about how AWS Ground Station should configure an antenna for +// downlink demod decode during a contact. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/AntennaDownlinkDemodDecodeConfig +type AntennaDownlinkDemodDecodeConfig struct { + _ struct{} `type:"structure"` + + // Information about the decode Config. + // + // DecodeConfig is a required field + DecodeConfig *DecodeConfig `locationName:"decodeConfig" type:"structure" required:"true"` + + // Information about the demodulation Config. + // + // DemodulationConfig is a required field + DemodulationConfig *DemodulationConfig `locationName:"demodulationConfig" type:"structure" required:"true"` + + // Information about the spectral Config. + // + // SpectrumConfig is a required field + SpectrumConfig *SpectrumConfig `locationName:"spectrumConfig" type:"structure" required:"true"` +} + +// String returns the string representation +func (s AntennaDownlinkDemodDecodeConfig) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AntennaDownlinkDemodDecodeConfig) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "AntennaDownlinkDemodDecodeConfig"} + + if s.DecodeConfig == nil { + invalidParams.Add(aws.NewErrParamRequired("DecodeConfig")) + } + + if s.DemodulationConfig == nil { + invalidParams.Add(aws.NewErrParamRequired("DemodulationConfig")) + } + + if s.SpectrumConfig == nil { + invalidParams.Add(aws.NewErrParamRequired("SpectrumConfig")) + } + if s.DecodeConfig != nil { + if err := s.DecodeConfig.Validate(); err != nil { + invalidParams.AddNested("DecodeConfig", err.(aws.ErrInvalidParams)) + } + } + if s.DemodulationConfig != nil { + if err := s.DemodulationConfig.Validate(); err != nil { + invalidParams.AddNested("DemodulationConfig", err.(aws.ErrInvalidParams)) + } + } + if s.SpectrumConfig != nil { + if err := s.SpectrumConfig.Validate(); err != nil { + invalidParams.AddNested("SpectrumConfig", err.(aws.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s AntennaDownlinkDemodDecodeConfig) MarshalFields(e protocol.FieldEncoder) error { + if s.DecodeConfig != nil { + v := s.DecodeConfig + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "decodeConfig", v, metadata) + } + if s.DemodulationConfig != nil { + v := s.DemodulationConfig + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "demodulationConfig", v, metadata) + } + if s.SpectrumConfig != nil { + v := s.SpectrumConfig + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "spectrumConfig", v, metadata) + } + return nil +} + +// Information about the uplink Config of an antenna. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/AntennaUplinkConfig +type AntennaUplinkConfig struct { + _ struct{} `type:"structure"` + + // Information about the uplink spectral Config. + // + // SpectrumConfig is a required field + SpectrumConfig *UplinkSpectrumConfig `locationName:"spectrumConfig" type:"structure" required:"true"` + + // EIRP of the target. + // + // TargetEirp is a required field + TargetEirp *Eirp `locationName:"targetEirp" type:"structure" required:"true"` +} + +// String returns the string representation +func (s AntennaUplinkConfig) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AntennaUplinkConfig) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "AntennaUplinkConfig"} + + if s.SpectrumConfig == nil { + invalidParams.Add(aws.NewErrParamRequired("SpectrumConfig")) + } + + if s.TargetEirp == nil { + invalidParams.Add(aws.NewErrParamRequired("TargetEirp")) + } + if s.SpectrumConfig != nil { + if err := s.SpectrumConfig.Validate(); err != nil { + invalidParams.AddNested("SpectrumConfig", err.(aws.ErrInvalidParams)) + } + } + if s.TargetEirp != nil { + if err := s.TargetEirp.Validate(); err != nil { + invalidParams.AddNested("TargetEirp", err.(aws.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s AntennaUplinkConfig) MarshalFields(e protocol.FieldEncoder) error { + if s.SpectrumConfig != nil { + v := s.SpectrumConfig + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "spectrumConfig", v, metadata) + } + if s.TargetEirp != nil { + v := s.TargetEirp + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "targetEirp", v, metadata) + } + return nil +} + +// An item in a list of Config objects. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ConfigListItem +type ConfigListItem struct { + _ struct{} `type:"structure"` + + // ARN of a Config. + ConfigArn *string `locationName:"configArn" type:"string"` + + // UUID of a Config. + ConfigId *string `locationName:"configId" type:"string"` + + // Type of a Config. + ConfigType ConfigCapabilityType `locationName:"configType" type:"string" enum:"true"` + + // Name of a Config. + Name *string `locationName:"name" type:"string"` +} + +// String returns the string representation +func (s ConfigListItem) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ConfigListItem) MarshalFields(e protocol.FieldEncoder) error { + if s.ConfigArn != nil { + v := *s.ConfigArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "configArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.ConfigId != nil { + v := *s.ConfigId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "configId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.ConfigType) > 0 { + v := s.ConfigType + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "configType", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + if s.Name != nil { + v := *s.Name + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "name", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Object containing the parameters for a Config. +// +// See the subtype definitions for what each type of Config contains. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ConfigTypeData +type ConfigTypeData struct { + _ struct{} `type:"structure"` + + // Information about how AWS Ground Station should configure an antenna for + // downlink during a contact. + AntennaDownlinkConfig *AntennaDownlinkConfig `locationName:"antennaDownlinkConfig" type:"structure"` + + // Information about how AWS Ground Station should configure an antenna for + // downlink demod decode during a contact. + AntennaDownlinkDemodDecodeConfig *AntennaDownlinkDemodDecodeConfig `locationName:"antennaDownlinkDemodDecodeConfig" type:"structure"` + + // Information about how AWS Ground Station should configure an antenna for + // uplink during a contact. + AntennaUplinkConfig *AntennaUplinkConfig `locationName:"antennaUplinkConfig" type:"structure"` + + // Information about the dataflow endpoint Config. + DataflowEndpointConfig *DataflowEndpointConfig `locationName:"dataflowEndpointConfig" type:"structure"` + + // Object that determines whether tracking should be used during a contact executed + // with this Config in the mission profile. + TrackingConfig *TrackingConfig `locationName:"trackingConfig" type:"structure"` + + // Information about an uplink echo Config. + // + // Parameters from the AntennaUplinkConfig, corresponding to the specified AntennaUplinkConfigArn, + // are used when this UplinkEchoConfig is used in a contact. + UplinkEchoConfig *UplinkEchoConfig `locationName:"uplinkEchoConfig" type:"structure"` +} + +// String returns the string representation +func (s ConfigTypeData) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ConfigTypeData) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "ConfigTypeData"} + if s.AntennaDownlinkConfig != nil { + if err := s.AntennaDownlinkConfig.Validate(); err != nil { + invalidParams.AddNested("AntennaDownlinkConfig", err.(aws.ErrInvalidParams)) + } + } + if s.AntennaDownlinkDemodDecodeConfig != nil { + if err := s.AntennaDownlinkDemodDecodeConfig.Validate(); err != nil { + invalidParams.AddNested("AntennaDownlinkDemodDecodeConfig", err.(aws.ErrInvalidParams)) + } + } + if s.AntennaUplinkConfig != nil { + if err := s.AntennaUplinkConfig.Validate(); err != nil { + invalidParams.AddNested("AntennaUplinkConfig", err.(aws.ErrInvalidParams)) + } + } + if s.DataflowEndpointConfig != nil { + if err := s.DataflowEndpointConfig.Validate(); err != nil { + invalidParams.AddNested("DataflowEndpointConfig", err.(aws.ErrInvalidParams)) + } + } + if s.TrackingConfig != nil { + if err := s.TrackingConfig.Validate(); err != nil { + invalidParams.AddNested("TrackingConfig", err.(aws.ErrInvalidParams)) + } + } + if s.UplinkEchoConfig != nil { + if err := s.UplinkEchoConfig.Validate(); err != nil { + invalidParams.AddNested("UplinkEchoConfig", err.(aws.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ConfigTypeData) MarshalFields(e protocol.FieldEncoder) error { + if s.AntennaDownlinkConfig != nil { + v := s.AntennaDownlinkConfig + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "antennaDownlinkConfig", v, metadata) + } + if s.AntennaDownlinkDemodDecodeConfig != nil { + v := s.AntennaDownlinkDemodDecodeConfig + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "antennaDownlinkDemodDecodeConfig", v, metadata) + } + if s.AntennaUplinkConfig != nil { + v := s.AntennaUplinkConfig + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "antennaUplinkConfig", v, metadata) + } + if s.DataflowEndpointConfig != nil { + v := s.DataflowEndpointConfig + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "dataflowEndpointConfig", v, metadata) + } + if s.TrackingConfig != nil { + v := s.TrackingConfig + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "trackingConfig", v, metadata) + } + if s.UplinkEchoConfig != nil { + v := s.UplinkEchoConfig + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "uplinkEchoConfig", v, metadata) + } + return nil +} + +// Data describing a contact. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/ContactData +type ContactData struct { + _ struct{} `type:"structure"` + + // UUID of a contact. + ContactId *string `locationName:"contactId" type:"string"` + + // Status of a contact. + ContactStatus ContactStatus `locationName:"contactStatus" type:"string" enum:"true"` + + // End time of a contact. + EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"unix"` + + // Error message of a contact. + ErrorMessage *string `locationName:"errorMessage" type:"string"` + + // Name of a ground station. + GroundStation *string `locationName:"groundStation" type:"string"` + + // Maximum elevation angle of a contact. + MaximumElevation *Elevation `locationName:"maximumElevation" type:"structure"` + + // ARN of a mission profile. + MissionProfileArn *string `locationName:"missionProfileArn" type:"string"` + + // Amount of time after a contact ends that you’d like to receive a CloudWatch + // event indicating the pass has finished. + PostPassEndTime *time.Time `locationName:"postPassEndTime" type:"timestamp" timestampFormat:"unix"` + + // Amount of time prior to contact start you’d like to receive a CloudWatch + // event indicating an upcoming pass. + PrePassStartTime *time.Time `locationName:"prePassStartTime" type:"timestamp" timestampFormat:"unix"` + + // ARN of a satellite. + SatelliteArn *string `locationName:"satelliteArn" type:"string"` + + // Start time of a contact. + StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"unix"` + + // Tags assigned to a contact. + Tags map[string]string `locationName:"tags" type:"map"` +} + +// String returns the string representation +func (s ContactData) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ContactData) MarshalFields(e protocol.FieldEncoder) error { + if s.ContactId != nil { + v := *s.ContactId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "contactId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.ContactStatus) > 0 { + v := s.ContactStatus + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "contactStatus", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + if s.EndTime != nil { + v := *s.EndTime + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "endTime", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if s.ErrorMessage != nil { + v := *s.ErrorMessage + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "errorMessage", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.GroundStation != nil { + v := *s.GroundStation + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "groundStation", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.MaximumElevation != nil { + v := s.MaximumElevation + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "maximumElevation", v, metadata) + } + if s.MissionProfileArn != nil { + v := *s.MissionProfileArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "missionProfileArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.PostPassEndTime != nil { + v := *s.PostPassEndTime + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "postPassEndTime", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if s.PrePassStartTime != nil { + v := *s.PrePassStartTime + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "prePassStartTime", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if s.SatelliteArn != nil { + v := *s.SatelliteArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "satelliteArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.StartTime != nil { + v := *s.StartTime + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "startTime", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if len(s.Tags) > 0 { + v := s.Tags + + metadata := protocol.Metadata{} + ms0 := e.Map(protocol.BodyTarget, "tags", metadata) + ms0.Start() + for k1, v1 := range v { + ms0.MapSetValue(k1, protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ms0.End() + + } + return nil +} + +// Information about a dataflow endpoint. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DataflowEndpoint +type DataflowEndpoint struct { + _ struct{} `type:"structure"` + + // Socket address of a dataflow endpoint. + Address *SocketAddress `locationName:"address" type:"structure"` + + // Name of a dataflow endpoint. + Name *string `locationName:"name" min:"1" type:"string"` + + // Status of a dataflow endpoint. + Status EndpointStatus `locationName:"status" type:"string" enum:"true"` +} + +// String returns the string representation +func (s DataflowEndpoint) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DataflowEndpoint) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "DataflowEndpoint"} + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(aws.NewErrParamMinLen("Name", 1)) + } + if s.Address != nil { + if err := s.Address.Validate(); err != nil { + invalidParams.AddNested("Address", err.(aws.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s DataflowEndpoint) MarshalFields(e protocol.FieldEncoder) error { + if s.Address != nil { + v := s.Address + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "address", v, metadata) + } + if s.Name != nil { + v := *s.Name + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "name", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.Status) > 0 { + v := s.Status + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "status", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + return nil +} + +// Information about the dataflow endpoint Config. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DataflowEndpointConfig +type DataflowEndpointConfig struct { + _ struct{} `type:"structure"` + + // Name of a dataflow endpoint. + // + // DataflowEndpointName is a required field + DataflowEndpointName *string `locationName:"dataflowEndpointName" type:"string" required:"true"` +} + +// String returns the string representation +func (s DataflowEndpointConfig) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DataflowEndpointConfig) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "DataflowEndpointConfig"} + + if s.DataflowEndpointName == nil { + invalidParams.Add(aws.NewErrParamRequired("DataflowEndpointName")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s DataflowEndpointConfig) MarshalFields(e protocol.FieldEncoder) error { + if s.DataflowEndpointName != nil { + v := *s.DataflowEndpointName + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "dataflowEndpointName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Item in a list of DataflowEndpoint groups. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DataflowEndpointListItem +type DataflowEndpointListItem struct { + _ struct{} `type:"structure"` + + // ARN of a dataflow endpoint group. + DataflowEndpointGroupArn *string `locationName:"dataflowEndpointGroupArn" type:"string"` + + // UUID of a dataflow endpoint group. + DataflowEndpointGroupId *string `locationName:"dataflowEndpointGroupId" type:"string"` +} + +// String returns the string representation +func (s DataflowEndpointListItem) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s DataflowEndpointListItem) MarshalFields(e protocol.FieldEncoder) error { + if s.DataflowEndpointGroupArn != nil { + v := *s.DataflowEndpointGroupArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "dataflowEndpointGroupArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.DataflowEndpointGroupId != nil { + v := *s.DataflowEndpointGroupId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "dataflowEndpointGroupId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Information about the decode Config. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DecodeConfig +type DecodeConfig struct { + _ struct{} `type:"structure"` + + // Unvalidated JSON of a decode Config. + // + // UnvalidatedJSON is a required field + UnvalidatedJSON *string `locationName:"unvalidatedJSON" min:"2" type:"string" required:"true"` +} + +// String returns the string representation +func (s DecodeConfig) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DecodeConfig) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "DecodeConfig"} + + if s.UnvalidatedJSON == nil { + invalidParams.Add(aws.NewErrParamRequired("UnvalidatedJSON")) + } + if s.UnvalidatedJSON != nil && len(*s.UnvalidatedJSON) < 2 { + invalidParams.Add(aws.NewErrParamMinLen("UnvalidatedJSON", 2)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s DecodeConfig) MarshalFields(e protocol.FieldEncoder) error { + if s.UnvalidatedJSON != nil { + v := *s.UnvalidatedJSON + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "unvalidatedJSON", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Information about the demodulation Config. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/DemodulationConfig +type DemodulationConfig struct { + _ struct{} `type:"structure"` + + // Unvalidated JSON of a demodulation Config. + // + // UnvalidatedJSON is a required field + UnvalidatedJSON *string `locationName:"unvalidatedJSON" min:"2" type:"string" required:"true"` +} + +// String returns the string representation +func (s DemodulationConfig) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DemodulationConfig) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "DemodulationConfig"} + + if s.UnvalidatedJSON == nil { + invalidParams.Add(aws.NewErrParamRequired("UnvalidatedJSON")) + } + if s.UnvalidatedJSON != nil && len(*s.UnvalidatedJSON) < 2 { + invalidParams.Add(aws.NewErrParamMinLen("UnvalidatedJSON", 2)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s DemodulationConfig) MarshalFields(e protocol.FieldEncoder) error { + if s.UnvalidatedJSON != nil { + v := *s.UnvalidatedJSON + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "unvalidatedJSON", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Object that represents EIRP. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/Eirp +type Eirp struct { + _ struct{} `type:"structure"` + + // Units of an EIRP. + // + // Units is a required field + Units EirpUnits `locationName:"units" type:"string" required:"true" enum:"true"` + + // Value of an EIRP. + // + // Value is a required field + Value *float64 `locationName:"value" type:"double" required:"true"` +} + +// String returns the string representation +func (s Eirp) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Eirp) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "Eirp"} + if len(s.Units) == 0 { + invalidParams.Add(aws.NewErrParamRequired("Units")) + } + + if s.Value == nil { + invalidParams.Add(aws.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s Eirp) MarshalFields(e protocol.FieldEncoder) error { + if len(s.Units) > 0 { + v := s.Units + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "units", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + if s.Value != nil { + v := *s.Value + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "value", protocol.Float64Value(v), metadata) + } + return nil +} + +// Elevation angle of the satellite in the sky during a contact. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/Elevation +type Elevation struct { + _ struct{} `type:"structure"` + + // Elevation angle units. + // + // Unit is a required field + Unit AngleUnits `locationName:"unit" type:"string" required:"true" enum:"true"` + + // Elevation angle value. + // + // Value is a required field + Value *float64 `locationName:"value" type:"double" required:"true"` +} + +// String returns the string representation +func (s Elevation) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s Elevation) MarshalFields(e protocol.FieldEncoder) error { + if len(s.Unit) > 0 { + v := s.Unit + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "unit", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + if s.Value != nil { + v := *s.Value + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "value", protocol.Float64Value(v), metadata) + } + return nil +} + +// Information about the endpoint details. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/EndpointDetails +type EndpointDetails struct { + _ struct{} `type:"structure"` + + // A dataflow endpoint. + Endpoint *DataflowEndpoint `locationName:"endpoint" type:"structure"` + + // Endpoint security details. + SecurityDetails *SecurityDetails `locationName:"securityDetails" type:"structure"` +} + +// String returns the string representation +func (s EndpointDetails) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EndpointDetails) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "EndpointDetails"} + if s.Endpoint != nil { + if err := s.Endpoint.Validate(); err != nil { + invalidParams.AddNested("Endpoint", err.(aws.ErrInvalidParams)) + } + } + if s.SecurityDetails != nil { + if err := s.SecurityDetails.Validate(); err != nil { + invalidParams.AddNested("SecurityDetails", err.(aws.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s EndpointDetails) MarshalFields(e protocol.FieldEncoder) error { + if s.Endpoint != nil { + v := s.Endpoint + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "endpoint", v, metadata) + } + if s.SecurityDetails != nil { + v := s.SecurityDetails + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "securityDetails", v, metadata) + } + return nil +} + +// Object that describes the frequency. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/Frequency +type Frequency struct { + _ struct{} `type:"structure"` + + // Frequency units. + // + // Units is a required field + Units FrequencyUnits `locationName:"units" type:"string" required:"true" enum:"true"` + + // Frequency value. + // + // Value is a required field + Value *float64 `locationName:"value" type:"double" required:"true"` +} + +// String returns the string representation +func (s Frequency) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Frequency) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "Frequency"} + if len(s.Units) == 0 { + invalidParams.Add(aws.NewErrParamRequired("Units")) + } + + if s.Value == nil { + invalidParams.Add(aws.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s Frequency) MarshalFields(e protocol.FieldEncoder) error { + if len(s.Units) > 0 { + v := s.Units + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "units", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + if s.Value != nil { + v := *s.Value + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "value", protocol.Float64Value(v), metadata) + } + return nil +} + +// Object that describes the frequency bandwidth. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/FrequencyBandwidth +type FrequencyBandwidth struct { + _ struct{} `type:"structure"` + + // Frequency bandwidth units. + // + // Units is a required field + Units BandwidthUnits `locationName:"units" type:"string" required:"true" enum:"true"` + + // Frequency bandwidth value. + // + // Value is a required field + Value *float64 `locationName:"value" type:"double" required:"true"` +} + +// String returns the string representation +func (s FrequencyBandwidth) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *FrequencyBandwidth) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "FrequencyBandwidth"} + if len(s.Units) == 0 { + invalidParams.Add(aws.NewErrParamRequired("Units")) + } + + if s.Value == nil { + invalidParams.Add(aws.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s FrequencyBandwidth) MarshalFields(e protocol.FieldEncoder) error { + if len(s.Units) > 0 { + v := s.Units + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "units", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + if s.Value != nil { + v := *s.Value + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "value", protocol.Float64Value(v), metadata) + } + return nil +} + +// Information about the ground station data. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/GroundStationData +type GroundStationData struct { + _ struct{} `type:"structure"` + + // ID of a ground station. + GroundStationId *string `locationName:"groundStationId" type:"string"` + + // Name of a ground station. + GroundStationName *string `locationName:"groundStationName" type:"string"` + + // Ground station Region. + Region *string `locationName:"region" type:"string"` +} + +// String returns the string representation +func (s GroundStationData) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s GroundStationData) MarshalFields(e protocol.FieldEncoder) error { + if s.GroundStationId != nil { + v := *s.GroundStationId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "groundStationId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.GroundStationName != nil { + v := *s.GroundStationName + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "groundStationName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.Region != nil { + v := *s.Region + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "region", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Item in a list of mission profiles. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/MissionProfileListItem +type MissionProfileListItem struct { + _ struct{} `type:"structure"` + + // ARN of a mission profile. + MissionProfileArn *string `locationName:"missionProfileArn" type:"string"` + + // ID of a mission profile. + MissionProfileId *string `locationName:"missionProfileId" type:"string"` + + // Name of a mission profile. + Name *string `locationName:"name" type:"string"` + + // Region of a mission profile. + Region *string `locationName:"region" type:"string"` +} + +// String returns the string representation +func (s MissionProfileListItem) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s MissionProfileListItem) MarshalFields(e protocol.FieldEncoder) error { + if s.MissionProfileArn != nil { + v := *s.MissionProfileArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "missionProfileArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.MissionProfileId != nil { + v := *s.MissionProfileId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "missionProfileId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.Name != nil { + v := *s.Name + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "name", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.Region != nil { + v := *s.Region + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "region", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Item in a list of satellites. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/SatelliteListItem +type SatelliteListItem struct { + _ struct{} `type:"structure"` + + // NORAD satellite ID number. + NoradSatelliteID *int64 `locationName:"noradSatelliteID" min:"1" type:"integer"` + + // ARN of a satellite. + SatelliteArn *string `locationName:"satelliteArn" type:"string"` + + // ID of a satellite. + SatelliteId *string `locationName:"satelliteId" min:"1" type:"string"` +} + +// String returns the string representation +func (s SatelliteListItem) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s SatelliteListItem) MarshalFields(e protocol.FieldEncoder) error { + if s.NoradSatelliteID != nil { + v := *s.NoradSatelliteID + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "noradSatelliteID", protocol.Int64Value(v), metadata) + } + if s.SatelliteArn != nil { + v := *s.SatelliteArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "satelliteArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.SatelliteId != nil { + v := *s.SatelliteId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "satelliteId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Information about endpoints. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/SecurityDetails +type SecurityDetails struct { + _ struct{} `type:"structure"` + + // ARN to a role needed for connecting streams to your instances. + // + // RoleArn is a required field + RoleArn *string `locationName:"roleArn" type:"string" required:"true"` + + // The security groups to attach to the elastic network interfaces. + // + // SecurityGroupIds is a required field + SecurityGroupIds []string `locationName:"securityGroupIds" type:"list" required:"true"` + + // A list of subnets where AWS Ground Station places elastic network interfaces + // to send streams to your instances. + // + // SubnetIds is a required field + SubnetIds []string `locationName:"subnetIds" type:"list" required:"true"` +} + +// String returns the string representation +func (s SecurityDetails) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SecurityDetails) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "SecurityDetails"} + + if s.RoleArn == nil { + invalidParams.Add(aws.NewErrParamRequired("RoleArn")) + } + + if s.SecurityGroupIds == nil { + invalidParams.Add(aws.NewErrParamRequired("SecurityGroupIds")) + } + + if s.SubnetIds == nil { + invalidParams.Add(aws.NewErrParamRequired("SubnetIds")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s SecurityDetails) MarshalFields(e protocol.FieldEncoder) error { + if s.RoleArn != nil { + v := *s.RoleArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "roleArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if len(s.SecurityGroupIds) > 0 { + v := s.SecurityGroupIds + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "securityGroupIds", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddValue(protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ls0.End() + + } + if len(s.SubnetIds) > 0 { + v := s.SubnetIds + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "subnetIds", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddValue(protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ls0.End() + + } + return nil +} + +// Information about the socket address. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/SocketAddress +type SocketAddress struct { + _ struct{} `type:"structure"` + + // Name of a socket address. + // + // Name is a required field + Name *string `locationName:"name" type:"string" required:"true"` + + // Port of a socket address. + // + // Port is a required field + Port *int64 `locationName:"port" type:"integer" required:"true"` +} + +// String returns the string representation +func (s SocketAddress) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SocketAddress) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "SocketAddress"} + + if s.Name == nil { + invalidParams.Add(aws.NewErrParamRequired("Name")) + } + + if s.Port == nil { + invalidParams.Add(aws.NewErrParamRequired("Port")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s SocketAddress) MarshalFields(e protocol.FieldEncoder) error { + if s.Name != nil { + v := *s.Name + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "name", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.Port != nil { + v := *s.Port + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "port", protocol.Int64Value(v), metadata) + } + return nil +} + +// Object that describes a spectral Config. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/SpectrumConfig +type SpectrumConfig struct { + _ struct{} `type:"structure"` + + // Bandwidth of a spectral Config. + // + // Bandwidth is a required field + Bandwidth *FrequencyBandwidth `locationName:"bandwidth" type:"structure" required:"true"` + + // Center frequency of a spectral Config. + // + // CenterFrequency is a required field + CenterFrequency *Frequency `locationName:"centerFrequency" type:"structure" required:"true"` + + // Polarization of a spectral Config. + Polarization Polarization `locationName:"polarization" type:"string" enum:"true"` +} + +// String returns the string representation +func (s SpectrumConfig) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SpectrumConfig) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "SpectrumConfig"} + + if s.Bandwidth == nil { + invalidParams.Add(aws.NewErrParamRequired("Bandwidth")) + } + + if s.CenterFrequency == nil { + invalidParams.Add(aws.NewErrParamRequired("CenterFrequency")) + } + if s.Bandwidth != nil { + if err := s.Bandwidth.Validate(); err != nil { + invalidParams.AddNested("Bandwidth", err.(aws.ErrInvalidParams)) + } + } + if s.CenterFrequency != nil { + if err := s.CenterFrequency.Validate(); err != nil { + invalidParams.AddNested("CenterFrequency", err.(aws.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s SpectrumConfig) MarshalFields(e protocol.FieldEncoder) error { + if s.Bandwidth != nil { + v := s.Bandwidth + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "bandwidth", v, metadata) + } + if s.CenterFrequency != nil { + v := s.CenterFrequency + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "centerFrequency", v, metadata) + } + if len(s.Polarization) > 0 { + v := s.Polarization + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "polarization", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + return nil +} + +// Object that determines whether tracking should be used during a contact executed +// with this Config in the mission profile. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/TrackingConfig +type TrackingConfig struct { + _ struct{} `type:"structure"` + + // Current setting for autotrack. + // + // Autotrack is a required field + Autotrack Criticality `locationName:"autotrack" type:"string" required:"true" enum:"true"` +} + +// String returns the string representation +func (s TrackingConfig) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TrackingConfig) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "TrackingConfig"} + if len(s.Autotrack) == 0 { + invalidParams.Add(aws.NewErrParamRequired("Autotrack")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s TrackingConfig) MarshalFields(e protocol.FieldEncoder) error { + if len(s.Autotrack) > 0 { + v := s.Autotrack + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "autotrack", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + return nil +} + +// Information about an uplink echo Config. +// +// Parameters from the AntennaUplinkConfig, corresponding to the specified AntennaUplinkConfigArn, +// are used when this UplinkEchoConfig is used in a contact. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UplinkEchoConfig +type UplinkEchoConfig struct { + _ struct{} `type:"structure"` + + // ARN of an uplink Config. + // + // AntennaUplinkConfigArn is a required field + AntennaUplinkConfigArn *string `locationName:"antennaUplinkConfigArn" type:"string" required:"true"` + + // Whether or not an uplink Config is enabled. + // + // Enabled is a required field + Enabled *bool `locationName:"enabled" type:"boolean" required:"true"` +} + +// String returns the string representation +func (s UplinkEchoConfig) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UplinkEchoConfig) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "UplinkEchoConfig"} + + if s.AntennaUplinkConfigArn == nil { + invalidParams.Add(aws.NewErrParamRequired("AntennaUplinkConfigArn")) + } + + if s.Enabled == nil { + invalidParams.Add(aws.NewErrParamRequired("Enabled")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s UplinkEchoConfig) MarshalFields(e protocol.FieldEncoder) error { + if s.AntennaUplinkConfigArn != nil { + v := *s.AntennaUplinkConfigArn + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "antennaUplinkConfigArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.Enabled != nil { + v := *s.Enabled + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "enabled", protocol.BoolValue(v), metadata) + } + return nil +} + +// Information about the uplink spectral Config. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/groundstation-2019-05-23/UplinkSpectrumConfig +type UplinkSpectrumConfig struct { + _ struct{} `type:"structure"` + + // Center frequency of an uplink spectral Config. + // + // CenterFrequency is a required field + CenterFrequency *Frequency `locationName:"centerFrequency" type:"structure" required:"true"` + + // Polarization of an uplink spectral Config. + Polarization Polarization `locationName:"polarization" type:"string" enum:"true"` +} + +// String returns the string representation +func (s UplinkSpectrumConfig) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UplinkSpectrumConfig) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "UplinkSpectrumConfig"} + + if s.CenterFrequency == nil { + invalidParams.Add(aws.NewErrParamRequired("CenterFrequency")) + } + if s.CenterFrequency != nil { + if err := s.CenterFrequency.Validate(); err != nil { + invalidParams.AddNested("CenterFrequency", err.(aws.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s UplinkSpectrumConfig) MarshalFields(e protocol.FieldEncoder) error { + if s.CenterFrequency != nil { + v := s.CenterFrequency + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "centerFrequency", v, metadata) + } + if len(s.Polarization) > 0 { + v := s.Polarization + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "polarization", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + return nil +} diff --git a/service/groundstation/groundstationiface/interface.go b/service/groundstation/groundstationiface/interface.go new file mode 100644 index 00000000000..d012a1120da --- /dev/null +++ b/service/groundstation/groundstationiface/interface.go @@ -0,0 +1,115 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package groundstationiface provides an interface to enable mocking the AWS Ground Station service client +// for testing your code. +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. +package groundstationiface + +import ( + "github.com/aws/aws-sdk-go-v2/service/groundstation" +) + +// ClientAPI provides an interface to enable mocking the +// groundstation.Client methods. This make unit testing your code that +// calls out to the SDK's service client's calls easier. +// +// The best way to use this interface is so the SDK's service client's calls +// can be stubbed out for unit testing your code with the SDK without needing +// to inject custom request handlers into the SDK's request pipeline. +// +// // myFunc uses an SDK service client to make a request to +// // AWS Ground Station. +// func myFunc(svc groundstationiface.ClientAPI) bool { +// // Make svc.CancelContact request +// } +// +// func main() { +// cfg, err := external.LoadDefaultAWSConfig() +// if err != nil { +// panic("failed to load config, " + err.Error()) +// } +// +// svc := groundstation.New(cfg) +// +// myFunc(svc) +// } +// +// In your _test.go file: +// +// // Define a mock struct to be used in your unit tests of myFunc. +// type mockClientClient struct { +// groundstationiface.ClientPI +// } +// func (m *mockClientClient) CancelContact(input *groundstation.CancelContactInput) (*groundstation.CancelContactOutput, error) { +// // mock response/functionality +// } +// +// func TestMyFunc(t *testing.T) { +// // Setup Test +// mockSvc := &mockClientClient{} +// +// myfunc(mockSvc) +// +// // Verify myFunc's functionality +// } +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. Its suggested to use the pattern above for testing, or using +// tooling to generate mocks to satisfy the interfaces. +type ClientAPI interface { + CancelContactRequest(*groundstation.CancelContactInput) groundstation.CancelContactRequest + + CreateConfigRequest(*groundstation.CreateConfigInput) groundstation.CreateConfigRequest + + CreateDataflowEndpointGroupRequest(*groundstation.CreateDataflowEndpointGroupInput) groundstation.CreateDataflowEndpointGroupRequest + + CreateMissionProfileRequest(*groundstation.CreateMissionProfileInput) groundstation.CreateMissionProfileRequest + + DeleteConfigRequest(*groundstation.DeleteConfigInput) groundstation.DeleteConfigRequest + + DeleteDataflowEndpointGroupRequest(*groundstation.DeleteDataflowEndpointGroupInput) groundstation.DeleteDataflowEndpointGroupRequest + + DeleteMissionProfileRequest(*groundstation.DeleteMissionProfileInput) groundstation.DeleteMissionProfileRequest + + DescribeContactRequest(*groundstation.DescribeContactInput) groundstation.DescribeContactRequest + + GetConfigRequest(*groundstation.GetConfigInput) groundstation.GetConfigRequest + + GetDataflowEndpointGroupRequest(*groundstation.GetDataflowEndpointGroupInput) groundstation.GetDataflowEndpointGroupRequest + + GetMinuteUsageRequest(*groundstation.GetMinuteUsageInput) groundstation.GetMinuteUsageRequest + + GetMissionProfileRequest(*groundstation.GetMissionProfileInput) groundstation.GetMissionProfileRequest + + GetSatelliteRequest(*groundstation.GetSatelliteInput) groundstation.GetSatelliteRequest + + ListConfigsRequest(*groundstation.ListConfigsInput) groundstation.ListConfigsRequest + + ListContactsRequest(*groundstation.ListContactsInput) groundstation.ListContactsRequest + + ListDataflowEndpointGroupsRequest(*groundstation.ListDataflowEndpointGroupsInput) groundstation.ListDataflowEndpointGroupsRequest + + ListGroundStationsRequest(*groundstation.ListGroundStationsInput) groundstation.ListGroundStationsRequest + + ListMissionProfilesRequest(*groundstation.ListMissionProfilesInput) groundstation.ListMissionProfilesRequest + + ListSatellitesRequest(*groundstation.ListSatellitesInput) groundstation.ListSatellitesRequest + + ListTagsForResourceRequest(*groundstation.ListTagsForResourceInput) groundstation.ListTagsForResourceRequest + + ReserveContactRequest(*groundstation.ReserveContactInput) groundstation.ReserveContactRequest + + TagResourceRequest(*groundstation.TagResourceInput) groundstation.TagResourceRequest + + UntagResourceRequest(*groundstation.UntagResourceInput) groundstation.UntagResourceRequest + + UpdateConfigRequest(*groundstation.UpdateConfigInput) groundstation.UpdateConfigRequest + + UpdateMissionProfileRequest(*groundstation.UpdateMissionProfileInput) groundstation.UpdateMissionProfileRequest +} + +var _ ClientAPI = (*groundstation.Client)(nil) diff --git a/service/pinpointemail/api_doc.go b/service/pinpointemail/api_doc.go index 95d3f11da2e..7611040abd7 100644 --- a/service/pinpointemail/api_doc.go +++ b/service/pinpointemail/api_doc.go @@ -7,17 +7,19 @@ // Email API, version 1.0. This document is best used in conjunction with the // Amazon Pinpoint Developer Guide (https://docs.aws.amazon.com/pinpoint/latest/developerguide/welcome.html). // -// The Amazon Pinpoint Email API is available in the US East (N. Virginia), -// US West (Oregon), EU (Frankfurt), and EU (Ireland) Regions at the following -// endpoints: -// -// * US East (N. Virginia): email.us-east-1.amazonaws.com -// -// * US West (Oregon): email.us-west-2.amazonaws.com -// -// * EU (Frankfurt): email.eu-central-1.amazonaws.com -// -// * EU (Ireland): email.eu-west-1.amazonaws.com +// The Amazon Pinpoint Email API is available in several AWS Regions and it +// provides an endpoint for each of these Regions. For a list of all the Regions +// and endpoints where the API is currently available, see AWS Regions and Endpoints +// (https://docs.aws.amazon.com/general/latest/gr/rande.html#pinpoint_region) +// in the Amazon Web Services General Reference. +// +// In each Region, AWS maintains multiple Availability Zones. These Availability +// Zones are physically isolated from each other, but are united by private, +// low-latency, high-throughput, and highly redundant network connections. These +// Availability Zones enable us to provide very high levels of availability +// and redundancy, while also minimizing latency. To learn more about the number +// of Availability Zones that are available in each Region, see AWS Global Infrastructure +// (http://aws.amazon.com/about-aws/global-infrastructure/). // // See https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26 for more information on this service. // diff --git a/service/pinpointemail/api_enums.go b/service/pinpointemail/api_enums.go index 36cda4b06ad..a4ae0157a91 100644 --- a/service/pinpointemail/api_enums.go +++ b/service/pinpointemail/api_enums.go @@ -27,6 +27,27 @@ func (enum BehaviorOnMxFailure) MarshalValueBuf(b []byte) ([]byte, error) { return append(b, enum...), nil } +// 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. +type DeliverabilityDashboardAccountStatus string + +// Enum values for DeliverabilityDashboardAccountStatus +const ( + DeliverabilityDashboardAccountStatusActive DeliverabilityDashboardAccountStatus = "ACTIVE" + DeliverabilityDashboardAccountStatusPendingExpiration DeliverabilityDashboardAccountStatus = "PENDING_EXPIRATION" + DeliverabilityDashboardAccountStatusDisabled DeliverabilityDashboardAccountStatus = "DISABLED" +) + +func (enum DeliverabilityDashboardAccountStatus) MarshalValue() (string, error) { + return string(enum), nil +} + +func (enum DeliverabilityDashboardAccountStatus) MarshalValueBuf(b []byte) ([]byte, error) { + b = b[0:0] + return append(b, enum...), nil +} + // The status of a 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 diff --git a/service/pinpointemail/api_integ_test.go b/service/pinpointemail/api_integ_test.go new file mode 100644 index 00000000000..15ee377605e --- /dev/null +++ b/service/pinpointemail/api_integ_test.go @@ -0,0 +1,62 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// +build go1.10,integration + +package pinpointemail_test + +import ( + "context" + "testing" + "time" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/aws/awserr" + "github.com/aws/aws-sdk-go-v2/internal/awstesting/integration" + "github.com/aws/aws-sdk-go-v2/service/pinpointemail" +) + +var _ aws.Config +var _ awserr.Error + +func TestInteg_00_ListConfigurationSets(t *testing.T) { + ctx, cancelFn := context.WithTimeout(context.Background(), 5*time.Second) + defer cancelFn() + + cfg := integration.ConfigWithDefaultRegion("us-west-2") + svc := pinpointemail.New(cfg) + params := &pinpointemail.ListConfigurationSetsInput{} + + req := svc.ListConfigurationSetsRequest(params) + + _, err := req.Send(ctx) + if err != nil { + t.Errorf("expect no error, got %v", err) + } +} +func TestInteg_01_PutConfigurationSetTrackingOptions(t *testing.T) { + ctx, cancelFn := context.WithTimeout(context.Background(), 5*time.Second) + defer cancelFn() + + cfg := integration.ConfigWithDefaultRegion("us-west-2") + svc := pinpointemail.New(cfg) + params := &pinpointemail.PutConfigurationSetTrackingOptionsInput{ + ConfigurationSetName: aws.String("config-set-name-not-exists"), + } + + req := svc.PutConfigurationSetTrackingOptionsRequest(params) + + _, err := req.Send(ctx) + if err == nil { + t.Fatalf("expect request to fail") + } + aerr, ok := err.(awserr.RequestFailure) + if !ok { + t.Fatalf("expect awserr, was %T", err) + } + if len(aerr.Code()) == 0 { + t.Errorf("expect non-empty error code") + } + if v := aerr.Code(); v == aws.ErrCodeSerialization { + t.Errorf("expect API error code got serialization failure") + } +} diff --git a/service/pinpointemail/api_op_CreateConfigurationSet.go b/service/pinpointemail/api_op_CreateConfigurationSet.go index 34bcf06921c..8d5304c207c 100644 --- a/service/pinpointemail/api_op_CreateConfigurationSet.go +++ b/service/pinpointemail/api_op_CreateConfigurationSet.go @@ -17,7 +17,9 @@ type CreateConfigurationSetInput struct { _ struct{} `type:"structure"` // The name of the configuration set. - ConfigurationSetName *string `type:"string"` + // + // ConfigurationSetName is a required field + ConfigurationSetName *string `type:"string" required:"true"` // An object that defines the dedicated IP pool that is used to send emails // that you send using the configuration set. @@ -31,8 +33,8 @@ type CreateConfigurationSetInput struct { // you send using the configuration set. SendingOptions *SendingOptions `type:"structure"` - // An object that defines the tags (keys and values) that you want to associate - // with the configuration set. + // An array of objects that define the tags (keys and values) that you want + // to associate with the configuration set. Tags []Tag `type:"list"` // An object that defines the open and click tracking options for emails that @@ -48,6 +50,10 @@ func (s CreateConfigurationSetInput) String() string { // Validate inspects the fields of the type to determine if they are valid. func (s *CreateConfigurationSetInput) Validate() error { invalidParams := aws.ErrInvalidParams{Context: "CreateConfigurationSetInput"} + + if s.ConfigurationSetName == nil { + invalidParams.Add(aws.NewErrParamRequired("ConfigurationSetName")) + } if s.Tags != nil { for i, v := range s.Tags { if err := v.Validate(); err != nil { diff --git a/service/pinpointemail/api_op_CreateDeliverabilityTestReport.go b/service/pinpointemail/api_op_CreateDeliverabilityTestReport.go index a8aa52975be..25227f4307d 100644 --- a/service/pinpointemail/api_op_CreateDeliverabilityTestReport.go +++ b/service/pinpointemail/api_op_CreateDeliverabilityTestReport.go @@ -39,8 +39,8 @@ type CreateDeliverabilityTestReportInput struct { // when you retrieve the results. ReportName *string `type:"string"` - // An object that defines the tags (keys and values) that you want to associate - // with the predictive inbox placement test. + // An array of objects that define the tags (keys and values) that you want + // to associate with the predictive inbox placement test. Tags []Tag `type:"list"` } diff --git a/service/pinpointemail/api_op_CreateEmailIdentity.go b/service/pinpointemail/api_op_CreateEmailIdentity.go index 1519ad3dbf7..1f9aef0036f 100644 --- a/service/pinpointemail/api_op_CreateEmailIdentity.go +++ b/service/pinpointemail/api_op_CreateEmailIdentity.go @@ -22,8 +22,8 @@ type CreateEmailIdentityInput struct { // EmailIdentity is a required field EmailIdentity *string `type:"string" required:"true"` - // An object that defines the tags (keys and values) that you want to associate - // with the email identity. + // An array of objects that define the tags (keys and values) that you want + // to associate with the email identity. Tags []Tag `type:"list"` } diff --git a/service/pinpointemail/api_op_GetBlacklistReports.go b/service/pinpointemail/api_op_GetBlacklistReports.go index 94e75c030a1..c930f4ad060 100644 --- a/service/pinpointemail/api_op_GetBlacklistReports.go +++ b/service/pinpointemail/api_op_GetBlacklistReports.go @@ -21,7 +21,7 @@ type GetBlacklistReportsInput struct { // using Amazon Pinpoint or Amazon SES. // // BlacklistItemNames is a required field - BlacklistItemNames []string `type:"list" required:"true"` + BlacklistItemNames []string `location:"querystring" locationName:"BlacklistItemNames" type:"list" required:"true"` } // String returns the string representation @@ -51,7 +51,7 @@ func (s GetBlacklistReportsInput) MarshalFields(e protocol.FieldEncoder) error { v := s.BlacklistItemNames metadata := protocol.Metadata{} - ls0 := e.List(protocol.BodyTarget, "BlacklistItemNames", metadata) + ls0 := e.List(protocol.QueryTarget, "BlacklistItemNames", metadata) ls0.Start() for _, v1 := range v { ls0.ListAddValue(protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) diff --git a/service/pinpointemail/api_op_GetConfigurationSet.go b/service/pinpointemail/api_op_GetConfigurationSet.go index f1b8ae5a020..781af2ff081 100644 --- a/service/pinpointemail/api_op_GetConfigurationSet.go +++ b/service/pinpointemail/api_op_GetConfigurationSet.go @@ -74,6 +74,10 @@ type GetConfigurationSetOutput struct { // you send using the configuration set. SendingOptions *SendingOptions `type:"structure"` + // An array of objects that define the tags (keys and values) that are associated + // with the configuration set. + Tags []Tag `type:"list"` + // An object that defines the open and click tracking options for emails that // you send using the configuration set. TrackingOptions *TrackingOptions `type:"structure"` @@ -110,6 +114,18 @@ func (s GetConfigurationSetOutput) MarshalFields(e protocol.FieldEncoder) error metadata := protocol.Metadata{} e.SetFields(protocol.BodyTarget, "SendingOptions", v, metadata) } + if len(s.Tags) > 0 { + v := s.Tags + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "Tags", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddFields(v1) + } + ls0.End() + + } if s.TrackingOptions != nil { v := s.TrackingOptions diff --git a/service/pinpointemail/api_op_GetDedicatedIps.go b/service/pinpointemail/api_op_GetDedicatedIps.go index 9f291ba8752..9561f0cd573 100644 --- a/service/pinpointemail/api_op_GetDedicatedIps.go +++ b/service/pinpointemail/api_op_GetDedicatedIps.go @@ -17,16 +17,16 @@ 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 `type:"string"` + NextToken *string `location:"querystring" locationName:"NextToken" type:"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 *int64 `type:"integer"` + PageSize *int64 `location:"querystring" locationName:"PageSize" type:"integer"` // The name of the IP pool that the dedicated IP address is associated with. - PoolName *string `type:"string"` + PoolName *string `location:"querystring" locationName:"PoolName" type:"string"` } // String returns the string representation @@ -42,19 +42,19 @@ func (s GetDedicatedIpsInput) MarshalFields(e protocol.FieldEncoder) error { v := *s.NextToken metadata := protocol.Metadata{} - e.SetValue(protocol.BodyTarget, "NextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + e.SetValue(protocol.QueryTarget, "NextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) } if s.PageSize != nil { v := *s.PageSize metadata := protocol.Metadata{} - e.SetValue(protocol.BodyTarget, "PageSize", protocol.Int64Value(v), metadata) + e.SetValue(protocol.QueryTarget, "PageSize", protocol.Int64Value(v), metadata) } if s.PoolName != nil { v := *s.PoolName metadata := protocol.Metadata{} - e.SetValue(protocol.BodyTarget, "PoolName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + e.SetValue(protocol.QueryTarget, "PoolName", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) } return nil } diff --git a/service/pinpointemail/api_op_GetDeliverabilityDashboardOptions.go b/service/pinpointemail/api_op_GetDeliverabilityDashboardOptions.go index d7e3882f33f..48cd2b2a1c8 100644 --- a/service/pinpointemail/api_op_GetDeliverabilityDashboardOptions.go +++ b/service/pinpointemail/api_op_GetDeliverabilityDashboardOptions.go @@ -4,23 +4,23 @@ package pinpointemail import ( "context" + "time" "github.com/aws/aws-sdk-go-v2/aws" "github.com/aws/aws-sdk-go-v2/internal/awsutil" "github.com/aws/aws-sdk-go-v2/private/protocol" ) -// A request to retrieve the status of the Deliverability dashboard for your -// account. When the Deliverability dashboard is enabled, you gain access to -// reputation metrics for the domains that you use to send email using Amazon -// Pinpoint. You also gain the ability to perform predictive inbox placement -// tests. +// Retrieve information about the status of the Deliverability dashboard for +// your Amazon Pinpoint account. When the Deliverability dashboard is enabled, +// you gain access to reputation, deliverability, and other metrics for the +// domains that you use to send email using Amazon Pinpoint. You also gain the +// ability to perform predictive inbox placement tests. // -// When you use the Deliverability dashboard, you pay a monthly charge of USD$1,250.00, -// in addition to any other fees that you accrue by using Amazon Pinpoint. If -// you enable the Deliverability dashboard after the first day of a calendar -// month, AWS prorates the monthly charge based on how many days have elapsed -// in the current calendar month. +// When you use the Deliverability dashboard, you pay a monthly subscription +// charge, in addition to any other fees that you accrue by using Amazon Pinpoint. +// For more information about the features and cost of a Deliverability dashboard +// subscription, see Amazon Pinpoint Pricing (http://aws.amazon.com/pinpoint/pricing/). // Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDeliverabilityDashboardOptionsRequest type GetDeliverabilityDashboardOptionsInput struct { _ struct{} `type:"structure"` @@ -44,11 +44,32 @@ func (s GetDeliverabilityDashboardOptionsInput) MarshalFields(e protocol.FieldEn type GetDeliverabilityDashboardOptionsOutput struct { _ struct{} `type:"structure"` - // Indicates whether the Deliverability dashboard is enabled. If the value is - // true, then the dashboard is enabled. + // 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 DeliverabilityDashboardAccountStatus `type:"string" enum:"true"` + + // 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 []DomainDeliverabilityTrackingOption `type:"list"` + + // Specifies whether the Deliverability dashboard is enabled for your Amazon + // Pinpoint account. If this value is true, the dashboard is enabled. // // DashboardEnabled is a required field DashboardEnabled *bool `type:"boolean" required:"true"` + + // 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 []DomainDeliverabilityTrackingOption `type:"list"` + + // 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 `type:"timestamp" timestampFormat:"unix"` } // String returns the string representation @@ -58,12 +79,48 @@ func (s GetDeliverabilityDashboardOptionsOutput) String() string { // MarshalFields encodes the AWS API shape using the passed in protocol encoder. func (s GetDeliverabilityDashboardOptionsOutput) MarshalFields(e protocol.FieldEncoder) error { + if len(s.AccountStatus) > 0 { + v := s.AccountStatus + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "AccountStatus", protocol.QuotedValue{ValueMarshaler: v}, metadata) + } + if len(s.ActiveSubscribedDomains) > 0 { + v := s.ActiveSubscribedDomains + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "ActiveSubscribedDomains", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddFields(v1) + } + ls0.End() + + } if s.DashboardEnabled != nil { v := *s.DashboardEnabled metadata := protocol.Metadata{} e.SetValue(protocol.BodyTarget, "DashboardEnabled", protocol.BoolValue(v), metadata) } + if len(s.PendingExpirationSubscribedDomains) > 0 { + v := s.PendingExpirationSubscribedDomains + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "PendingExpirationSubscribedDomains", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddFields(v1) + } + ls0.End() + + } + if s.SubscriptionExpiryDate != nil { + v := *s.SubscriptionExpiryDate + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "SubscriptionExpiryDate", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } return nil } @@ -72,16 +129,16 @@ const opGetDeliverabilityDashboardOptions = "GetDeliverabilityDashboardOptions" // GetDeliverabilityDashboardOptionsRequest returns a request value for making API operation for // Amazon Pinpoint Email Service. // -// Show the status of the Deliverability dashboard. When the Deliverability -// dashboard is enabled, you gain access to reputation metrics for the domains -// that you use to send email using Amazon Pinpoint. You also gain the ability -// to perform predictive inbox placement tests. +// Retrieve information about the status of the Deliverability dashboard for +// your Amazon Pinpoint account. When the Deliverability dashboard is enabled, +// you gain access to reputation, deliverability, and other metrics for the +// domains that you use to send email using Amazon Pinpoint. You also gain the +// ability to perform predictive inbox placement tests. // -// When you use the Deliverability dashboard, you pay a monthly charge of USD$1,250.00, -// in addition to any other fees that you accrue by using Amazon Pinpoint. If -// you enable the Deliverability dashboard after the first day of a calendar -// month, AWS prorates the monthly charge based on how many days have elapsed -// in the current calendar month. +// When you use the Deliverability dashboard, you pay a monthly subscription +// charge, in addition to any other fees that you accrue by using Amazon Pinpoint. +// For more information about the features and cost of a Deliverability dashboard +// subscription, see Amazon Pinpoint Pricing (http://aws.amazon.com/pinpoint/pricing/). // // // Example sending a request using GetDeliverabilityDashboardOptionsRequest. // req := client.GetDeliverabilityDashboardOptionsRequest(params) diff --git a/service/pinpointemail/api_op_GetDeliverabilityTestReport.go b/service/pinpointemail/api_op_GetDeliverabilityTestReport.go index cd2a25c7805..d0a7ee5fb1f 100644 --- a/service/pinpointemail/api_op_GetDeliverabilityTestReport.go +++ b/service/pinpointemail/api_op_GetDeliverabilityTestReport.go @@ -79,6 +79,10 @@ type GetDeliverabilityTestReportOutput struct { // // OverallPlacement is a required field OverallPlacement *PlacementStatistics `type:"structure" required:"true"` + + // An array of objects that define the tags (keys and values) that are associated + // with the predictive inbox placement test. + Tags []Tag `type:"list"` } // String returns the string representation @@ -118,6 +122,18 @@ func (s GetDeliverabilityTestReportOutput) MarshalFields(e protocol.FieldEncoder metadata := protocol.Metadata{} e.SetFields(protocol.BodyTarget, "OverallPlacement", v, metadata) } + if len(s.Tags) > 0 { + v := s.Tags + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "Tags", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddFields(v1) + } + ls0.End() + + } return nil } diff --git a/service/pinpointemail/api_op_GetDomainDeliverabilityCampaign.go b/service/pinpointemail/api_op_GetDomainDeliverabilityCampaign.go new file mode 100644 index 00000000000..26d0c6a57b8 --- /dev/null +++ b/service/pinpointemail/api_op_GetDomainDeliverabilityCampaign.go @@ -0,0 +1,162 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package pinpointemail + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Retrieve all the deliverability data for a specific campaign. This data is +// available for a campaign only if the campaign sent email by using a domain +// that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption +// operation). +// Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDomainDeliverabilityCampaignRequest +type GetDomainDeliverabilityCampaignInput struct { + _ struct{} `type:"structure"` + + // The unique identifier for the campaign. Amazon Pinpoint automatically generates + // and assigns this identifier to a campaign. This value is not the same as + // the campaign identifier that Amazon Pinpoint assigns to campaigns that you + // create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint + // console. + // + // CampaignId is a required field + CampaignId *string `location:"uri" locationName:"CampaignId" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetDomainDeliverabilityCampaignInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetDomainDeliverabilityCampaignInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "GetDomainDeliverabilityCampaignInput"} + + if s.CampaignId == nil { + invalidParams.Add(aws.NewErrParamRequired("CampaignId")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s GetDomainDeliverabilityCampaignInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.CampaignId != nil { + v := *s.CampaignId + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "CampaignId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// An object that contains all the deliverability data for a specific campaign. +// This data is available for a campaign only if the campaign sent email by +// using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption +// operation). +// Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDomainDeliverabilityCampaignResponse +type GetDomainDeliverabilityCampaignOutput struct { + _ struct{} `type:"structure"` + + // An object that contains the deliverability data for the campaign. + // + // DomainDeliverabilityCampaign is a required field + DomainDeliverabilityCampaign *DomainDeliverabilityCampaign `type:"structure" required:"true"` +} + +// String returns the string representation +func (s GetDomainDeliverabilityCampaignOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s GetDomainDeliverabilityCampaignOutput) MarshalFields(e protocol.FieldEncoder) error { + if s.DomainDeliverabilityCampaign != nil { + v := s.DomainDeliverabilityCampaign + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "DomainDeliverabilityCampaign", v, metadata) + } + return nil +} + +const opGetDomainDeliverabilityCampaign = "GetDomainDeliverabilityCampaign" + +// GetDomainDeliverabilityCampaignRequest returns a request value for making API operation for +// Amazon Pinpoint Email Service. +// +// Retrieve all the deliverability data for a specific campaign. This data is +// available for a campaign only if the campaign sent email by using a domain +// that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption +// operation). +// +// // Example sending a request using GetDomainDeliverabilityCampaignRequest. +// req := client.GetDomainDeliverabilityCampaignRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/GetDomainDeliverabilityCampaign +func (c *Client) GetDomainDeliverabilityCampaignRequest(input *GetDomainDeliverabilityCampaignInput) GetDomainDeliverabilityCampaignRequest { + op := &aws.Operation{ + Name: opGetDomainDeliverabilityCampaign, + HTTPMethod: "GET", + HTTPPath: "/v1/email/deliverability-dashboard/campaigns/{CampaignId}", + } + + if input == nil { + input = &GetDomainDeliverabilityCampaignInput{} + } + + req := c.newRequest(op, input, &GetDomainDeliverabilityCampaignOutput{}) + return GetDomainDeliverabilityCampaignRequest{Request: req, Input: input, Copy: c.GetDomainDeliverabilityCampaignRequest} +} + +// GetDomainDeliverabilityCampaignRequest is the request type for the +// GetDomainDeliverabilityCampaign API operation. +type GetDomainDeliverabilityCampaignRequest struct { + *aws.Request + Input *GetDomainDeliverabilityCampaignInput + Copy func(*GetDomainDeliverabilityCampaignInput) GetDomainDeliverabilityCampaignRequest +} + +// Send marshals and sends the GetDomainDeliverabilityCampaign API request. +func (r GetDomainDeliverabilityCampaignRequest) Send(ctx context.Context) (*GetDomainDeliverabilityCampaignResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &GetDomainDeliverabilityCampaignResponse{ + GetDomainDeliverabilityCampaignOutput: r.Request.Data.(*GetDomainDeliverabilityCampaignOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// GetDomainDeliverabilityCampaignResponse is the response type for the +// GetDomainDeliverabilityCampaign API operation. +type GetDomainDeliverabilityCampaignResponse struct { + *GetDomainDeliverabilityCampaignOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// GetDomainDeliverabilityCampaign request. +func (r *GetDomainDeliverabilityCampaignResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/pinpointemail/api_op_GetDomainStatisticsReport.go b/service/pinpointemail/api_op_GetDomainStatisticsReport.go index e0e46c22f6d..1b37280e268 100644 --- a/service/pinpointemail/api_op_GetDomainStatisticsReport.go +++ b/service/pinpointemail/api_op_GetDomainStatisticsReport.go @@ -26,13 +26,13 @@ type GetDomainStatisticsReportInput struct { // 30 days after the StartDate. // // EndDate is a required field - EndDate *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"` + EndDate *time.Time `location:"querystring" locationName:"EndDate" type:"timestamp" timestampFormat:"unix" required:"true"` // The first day (in Unix time) that you want to obtain domain deliverability // metrics for. // // StartDate is a required field - StartDate *time.Time `type:"timestamp" timestampFormat:"unix" required:"true"` + StartDate *time.Time `location:"querystring" locationName:"StartDate" type:"timestamp" timestampFormat:"unix" required:"true"` } // String returns the string representation @@ -66,23 +66,23 @@ func (s *GetDomainStatisticsReportInput) Validate() error { func (s GetDomainStatisticsReportInput) MarshalFields(e protocol.FieldEncoder) error { e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + if s.Domain != nil { + v := *s.Domain + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "Domain", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } if s.EndDate != nil { v := *s.EndDate metadata := protocol.Metadata{} - e.SetValue(protocol.BodyTarget, "EndDate", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + e.SetValue(protocol.QueryTarget, "EndDate", protocol.TimeValue{V: v, Format: protocol.RFC822TimeFromat}, metadata) } if s.StartDate != nil { v := *s.StartDate metadata := protocol.Metadata{} - e.SetValue(protocol.BodyTarget, "StartDate", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) - } - if s.Domain != nil { - v := *s.Domain - - metadata := protocol.Metadata{} - e.SetValue(protocol.PathTarget, "Domain", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + e.SetValue(protocol.QueryTarget, "StartDate", protocol.TimeValue{V: v, Format: protocol.RFC822TimeFromat}, metadata) } return nil } diff --git a/service/pinpointemail/api_op_GetEmailIdentity.go b/service/pinpointemail/api_op_GetEmailIdentity.go index 7a8b01a4f54..5c62a095478 100644 --- a/service/pinpointemail/api_op_GetEmailIdentity.go +++ b/service/pinpointemail/api_op_GetEmailIdentity.go @@ -85,6 +85,10 @@ type GetEmailIdentityOutput struct { // email identity. MailFromAttributes *MailFromAttributes `type:"structure"` + // An array of objects that define the tags (keys and values) that are associated + // with the email identity. + Tags []Tag `type:"list"` + // Specifies whether or not the identity is verified. In Amazon Pinpoint, 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). @@ -122,6 +126,18 @@ func (s GetEmailIdentityOutput) MarshalFields(e protocol.FieldEncoder) error { metadata := protocol.Metadata{} e.SetFields(protocol.BodyTarget, "MailFromAttributes", v, metadata) } + if len(s.Tags) > 0 { + v := s.Tags + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "Tags", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddFields(v1) + } + ls0.End() + + } if s.VerifiedForSendingStatus != nil { v := *s.VerifiedForSendingStatus diff --git a/service/pinpointemail/api_op_ListConfigurationSets.go b/service/pinpointemail/api_op_ListConfigurationSets.go index eb88488c013..e99863a68ce 100644 --- a/service/pinpointemail/api_op_ListConfigurationSets.go +++ b/service/pinpointemail/api_op_ListConfigurationSets.go @@ -18,13 +18,13 @@ type ListConfigurationSetsInput struct { // A token returned from a previous call to ListConfigurationSets to indicate // the position in the list of configuration sets. - NextToken *string `type:"string"` + NextToken *string `location:"querystring" locationName:"NextToken" type:"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 *int64 `type:"integer"` + PageSize *int64 `location:"querystring" locationName:"PageSize" type:"integer"` } // String returns the string representation @@ -40,13 +40,13 @@ func (s ListConfigurationSetsInput) MarshalFields(e protocol.FieldEncoder) error v := *s.NextToken metadata := protocol.Metadata{} - e.SetValue(protocol.BodyTarget, "NextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + e.SetValue(protocol.QueryTarget, "NextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) } if s.PageSize != nil { v := *s.PageSize metadata := protocol.Metadata{} - e.SetValue(protocol.BodyTarget, "PageSize", protocol.Int64Value(v), metadata) + e.SetValue(protocol.QueryTarget, "PageSize", protocol.Int64Value(v), metadata) } return nil } diff --git a/service/pinpointemail/api_op_ListDedicatedIpPools.go b/service/pinpointemail/api_op_ListDedicatedIpPools.go index 6f29de99680..cae13797a99 100644 --- a/service/pinpointemail/api_op_ListDedicatedIpPools.go +++ b/service/pinpointemail/api_op_ListDedicatedIpPools.go @@ -17,13 +17,13 @@ type ListDedicatedIpPoolsInput struct { // A token returned from a previous call to ListDedicatedIpPools to indicate // the position in the list of dedicated IP pools. - NextToken *string `type:"string"` + NextToken *string `location:"querystring" locationName:"NextToken" type:"string"` // The number of results to show in a single call to ListDedicatedIpPools. 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 *int64 `type:"integer"` + PageSize *int64 `location:"querystring" locationName:"PageSize" type:"integer"` } // String returns the string representation @@ -39,13 +39,13 @@ func (s ListDedicatedIpPoolsInput) MarshalFields(e protocol.FieldEncoder) error v := *s.NextToken metadata := protocol.Metadata{} - e.SetValue(protocol.BodyTarget, "NextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + e.SetValue(protocol.QueryTarget, "NextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) } if s.PageSize != nil { v := *s.PageSize metadata := protocol.Metadata{} - e.SetValue(protocol.BodyTarget, "PageSize", protocol.Int64Value(v), metadata) + e.SetValue(protocol.QueryTarget, "PageSize", protocol.Int64Value(v), metadata) } return nil } diff --git a/service/pinpointemail/api_op_ListDeliverabilityTestReports.go b/service/pinpointemail/api_op_ListDeliverabilityTestReports.go index c2eac58df88..a8611093fdb 100644 --- a/service/pinpointemail/api_op_ListDeliverabilityTestReports.go +++ b/service/pinpointemail/api_op_ListDeliverabilityTestReports.go @@ -18,7 +18,7 @@ type ListDeliverabilityTestReportsInput struct { // A token returned from a previous call to ListDeliverabilityTestReports to // indicate the position in the list of predictive inbox placement tests. - NextToken *string `type:"string"` + NextToken *string `location:"querystring" locationName:"NextToken" type:"string"` // The number of results to show in a single call to ListDeliverabilityTestReports. // If the number of results is larger than the number you specified in this @@ -26,7 +26,7 @@ type ListDeliverabilityTestReportsInput struct { // use to obtain additional results. // // The value you specify has to be at least 0, and can be no more than 1000. - PageSize *int64 `type:"integer"` + PageSize *int64 `location:"querystring" locationName:"PageSize" type:"integer"` } // String returns the string representation @@ -42,13 +42,13 @@ func (s ListDeliverabilityTestReportsInput) MarshalFields(e protocol.FieldEncode v := *s.NextToken metadata := protocol.Metadata{} - e.SetValue(protocol.BodyTarget, "NextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + e.SetValue(protocol.QueryTarget, "NextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) } if s.PageSize != nil { v := *s.PageSize metadata := protocol.Metadata{} - e.SetValue(protocol.BodyTarget, "PageSize", protocol.Int64Value(v), metadata) + e.SetValue(protocol.QueryTarget, "PageSize", protocol.Int64Value(v), metadata) } return nil } diff --git a/service/pinpointemail/api_op_ListDomainDeliverabilityCampaigns.go b/service/pinpointemail/api_op_ListDomainDeliverabilityCampaigns.go new file mode 100644 index 00000000000..88d8026f6a4 --- /dev/null +++ b/service/pinpointemail/api_op_ListDomainDeliverabilityCampaigns.go @@ -0,0 +1,286 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package pinpointemail + +import ( + "context" + "time" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Retrieve deliverability data for all the campaigns that used a specific domain +// to send email during a specified time range. This data is available for a +// domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption +// operation) for the domain. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListDomainDeliverabilityCampaignsRequest +type ListDomainDeliverabilityCampaignsInput struct { + _ struct{} `type:"structure"` + + // 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. + // + // EndDate is a required field + EndDate *time.Time `location:"querystring" locationName:"EndDate" type:"timestamp" timestampFormat:"unix" required:"true"` + + // 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 `location:"querystring" locationName:"NextToken" type:"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 *int64 `location:"querystring" locationName:"PageSize" type:"integer"` + + // The first day, in Unix time format, that you want to obtain deliverability + // data for. + // + // StartDate is a required field + StartDate *time.Time `location:"querystring" locationName:"StartDate" type:"timestamp" timestampFormat:"unix" required:"true"` + + // The domain to obtain deliverability data for. + // + // SubscribedDomain is a required field + SubscribedDomain *string `location:"uri" locationName:"SubscribedDomain" type:"string" required:"true"` +} + +// String returns the string representation +func (s ListDomainDeliverabilityCampaignsInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListDomainDeliverabilityCampaignsInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "ListDomainDeliverabilityCampaignsInput"} + + if s.EndDate == nil { + invalidParams.Add(aws.NewErrParamRequired("EndDate")) + } + + if s.StartDate == nil { + invalidParams.Add(aws.NewErrParamRequired("StartDate")) + } + + if s.SubscribedDomain == nil { + invalidParams.Add(aws.NewErrParamRequired("SubscribedDomain")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListDomainDeliverabilityCampaignsInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.SubscribedDomain != nil { + v := *s.SubscribedDomain + + metadata := protocol.Metadata{} + e.SetValue(protocol.PathTarget, "SubscribedDomain", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.EndDate != nil { + v := *s.EndDate + + metadata := protocol.Metadata{} + e.SetValue(protocol.QueryTarget, "EndDate", protocol.TimeValue{V: v, Format: protocol.RFC822TimeFromat}, metadata) + } + if s.NextToken != nil { + v := *s.NextToken + + metadata := protocol.Metadata{} + e.SetValue(protocol.QueryTarget, "NextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.PageSize != nil { + v := *s.PageSize + + metadata := protocol.Metadata{} + e.SetValue(protocol.QueryTarget, "PageSize", protocol.Int64Value(v), metadata) + } + if s.StartDate != nil { + v := *s.StartDate + + metadata := protocol.Metadata{} + e.SetValue(protocol.QueryTarget, "StartDate", protocol.TimeValue{V: v, Format: protocol.RFC822TimeFromat}, metadata) + } + return nil +} + +// An array of objects that provide deliverability data for all the campaigns +// that used a specific domain to send email during a specified time range. +// This data is available for a domain only if you enabled the Deliverability +// dashboard (PutDeliverabilityDashboardOption operation) for the domain. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListDomainDeliverabilityCampaignsResponse +type ListDomainDeliverabilityCampaignsOutput struct { + _ struct{} `type:"structure"` + + // An array of responses, one for each campaign that used the domain to send + // email during the specified time range. + // + // DomainDeliverabilityCampaigns is a required field + DomainDeliverabilityCampaigns []DomainDeliverabilityCampaign `type:"list" required:"true"` + + // A token that’s returned from a previous call to the ListDomainDeliverabilityCampaigns + // operation. This token indicates the position of the campaign in the list + // of campaigns. + NextToken *string `type:"string"` +} + +// String returns the string representation +func (s ListDomainDeliverabilityCampaignsOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s ListDomainDeliverabilityCampaignsOutput) MarshalFields(e protocol.FieldEncoder) error { + if len(s.DomainDeliverabilityCampaigns) > 0 { + v := s.DomainDeliverabilityCampaigns + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "DomainDeliverabilityCampaigns", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddFields(v1) + } + ls0.End() + + } + if s.NextToken != nil { + v := *s.NextToken + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "NextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +const opListDomainDeliverabilityCampaigns = "ListDomainDeliverabilityCampaigns" + +// ListDomainDeliverabilityCampaignsRequest returns a request value for making API operation for +// Amazon Pinpoint Email Service. +// +// Retrieve deliverability data for all the campaigns that used a specific domain +// to send email during a specified time range. This data is available for a +// domain only if you enabled the Deliverability dashboard (PutDeliverabilityDashboardOption +// operation) for the domain. +// +// // Example sending a request using ListDomainDeliverabilityCampaignsRequest. +// req := client.ListDomainDeliverabilityCampaignsRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/ListDomainDeliverabilityCampaigns +func (c *Client) ListDomainDeliverabilityCampaignsRequest(input *ListDomainDeliverabilityCampaignsInput) ListDomainDeliverabilityCampaignsRequest { + op := &aws.Operation{ + Name: opListDomainDeliverabilityCampaigns, + HTTPMethod: "GET", + HTTPPath: "/v1/email/deliverability-dashboard/domains/{SubscribedDomain}/campaigns", + Paginator: &aws.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "PageSize", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListDomainDeliverabilityCampaignsInput{} + } + + req := c.newRequest(op, input, &ListDomainDeliverabilityCampaignsOutput{}) + return ListDomainDeliverabilityCampaignsRequest{Request: req, Input: input, Copy: c.ListDomainDeliverabilityCampaignsRequest} +} + +// ListDomainDeliverabilityCampaignsRequest is the request type for the +// ListDomainDeliverabilityCampaigns API operation. +type ListDomainDeliverabilityCampaignsRequest struct { + *aws.Request + Input *ListDomainDeliverabilityCampaignsInput + Copy func(*ListDomainDeliverabilityCampaignsInput) ListDomainDeliverabilityCampaignsRequest +} + +// Send marshals and sends the ListDomainDeliverabilityCampaigns API request. +func (r ListDomainDeliverabilityCampaignsRequest) Send(ctx context.Context) (*ListDomainDeliverabilityCampaignsResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &ListDomainDeliverabilityCampaignsResponse{ + ListDomainDeliverabilityCampaignsOutput: r.Request.Data.(*ListDomainDeliverabilityCampaignsOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// NewListDomainDeliverabilityCampaignsRequestPaginator returns a paginator for ListDomainDeliverabilityCampaigns. +// Use Next method to get the next page, and CurrentPage to get the current +// response page from the paginator. Next will return false, if there are +// no more pages, or an error was encountered. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over pages. +// req := client.ListDomainDeliverabilityCampaignsRequest(input) +// p := pinpointemail.NewListDomainDeliverabilityCampaignsRequestPaginator(req) +// +// for p.Next(context.TODO()) { +// page := p.CurrentPage() +// } +// +// if err := p.Err(); err != nil { +// return err +// } +// +func NewListDomainDeliverabilityCampaignsPaginator(req ListDomainDeliverabilityCampaignsRequest) ListDomainDeliverabilityCampaignsPaginator { + return ListDomainDeliverabilityCampaignsPaginator{ + Pager: aws.Pager{ + NewRequest: func(ctx context.Context) (*aws.Request, error) { + var inCpy *ListDomainDeliverabilityCampaignsInput + if req.Input != nil { + tmp := *req.Input + inCpy = &tmp + } + + newReq := req.Copy(inCpy) + newReq.SetContext(ctx) + return newReq.Request, nil + }, + }, + } +} + +// ListDomainDeliverabilityCampaignsPaginator is used to paginate the request. This can be done by +// calling Next and CurrentPage. +type ListDomainDeliverabilityCampaignsPaginator struct { + aws.Pager +} + +func (p *ListDomainDeliverabilityCampaignsPaginator) CurrentPage() *ListDomainDeliverabilityCampaignsOutput { + return p.Pager.CurrentPage().(*ListDomainDeliverabilityCampaignsOutput) +} + +// ListDomainDeliverabilityCampaignsResponse is the response type for the +// ListDomainDeliverabilityCampaigns API operation. +type ListDomainDeliverabilityCampaignsResponse struct { + *ListDomainDeliverabilityCampaignsOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// ListDomainDeliverabilityCampaigns request. +func (r *ListDomainDeliverabilityCampaignsResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/pinpointemail/api_op_ListEmailIdentities.go b/service/pinpointemail/api_op_ListEmailIdentities.go index 1a863935215..d934d9d8cc2 100644 --- a/service/pinpointemail/api_op_ListEmailIdentities.go +++ b/service/pinpointemail/api_op_ListEmailIdentities.go @@ -20,7 +20,7 @@ type ListEmailIdentitiesInput struct { // A token returned from a previous call to ListEmailIdentities to indicate // the position in the list of identities. - NextToken *string `type:"string"` + NextToken *string `location:"querystring" locationName:"NextToken" type:"string"` // The number of results to show in a single call to ListEmailIdentities. If // the number of results is larger than the number you specified in this parameter, @@ -28,7 +28,7 @@ type ListEmailIdentitiesInput struct { // additional results. // // The value you specify has to be at least 0, and can be no more than 1000. - PageSize *int64 `type:"integer"` + PageSize *int64 `location:"querystring" locationName:"PageSize" type:"integer"` } // String returns the string representation @@ -44,13 +44,13 @@ func (s ListEmailIdentitiesInput) MarshalFields(e protocol.FieldEncoder) error { v := *s.NextToken metadata := protocol.Metadata{} - e.SetValue(protocol.BodyTarget, "NextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + e.SetValue(protocol.QueryTarget, "NextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) } if s.PageSize != nil { v := *s.PageSize metadata := protocol.Metadata{} - e.SetValue(protocol.BodyTarget, "PageSize", protocol.Int64Value(v), metadata) + e.SetValue(protocol.QueryTarget, "PageSize", protocol.Int64Value(v), metadata) } return nil } diff --git a/service/pinpointemail/api_op_ListTagsForResource.go b/service/pinpointemail/api_op_ListTagsForResource.go index 7fb382bd0b9..669708a3b1a 100644 --- a/service/pinpointemail/api_op_ListTagsForResource.go +++ b/service/pinpointemail/api_op_ListTagsForResource.go @@ -18,7 +18,7 @@ type ListTagsForResourceInput struct { // tag information for. // // ResourceArn is a required field - ResourceArn *string `type:"string" required:"true"` + ResourceArn *string `location:"querystring" locationName:"ResourceArn" type:"string" required:"true"` } // String returns the string representation @@ -48,7 +48,7 @@ func (s ListTagsForResourceInput) MarshalFields(e protocol.FieldEncoder) error { v := *s.ResourceArn metadata := protocol.Metadata{} - e.SetValue(protocol.BodyTarget, "ResourceArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + e.SetValue(protocol.QueryTarget, "ResourceArn", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) } return nil } @@ -92,7 +92,7 @@ const opListTagsForResource = "ListTagsForResource" // Amazon Pinpoint Email Service. // // Retrieve a list of the tags (keys and values) that are associated with a -// specific resource. A tag is a label that you optionally define and associate +// specified resource. A tag is a label that you optionally define and associate // with a resource in Amazon Pinpoint. Each tag consists of a required tag key // and an optional associated tag value. A tag key is a general label that acts // as a category for more specific tag values. A tag value acts as a descriptor diff --git a/service/pinpointemail/api_op_PutDeliverabilityDashboardOption.go b/service/pinpointemail/api_op_PutDeliverabilityDashboardOption.go index 20e6230c912..e7f9c5ec97c 100644 --- a/service/pinpointemail/api_op_PutDeliverabilityDashboardOption.go +++ b/service/pinpointemail/api_op_PutDeliverabilityDashboardOption.go @@ -10,25 +10,29 @@ import ( "github.com/aws/aws-sdk-go-v2/private/protocol" ) -// A request to enable or disable the Deliverability dashboard. When you enable -// the Deliverability dashboard, you gain access to reputation metrics for the -// domains that you use to send email using Amazon Pinpoint. You also gain the -// ability to perform predictive inbox placement tests. +// Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. +// When you enable the Deliverability dashboard, you gain access to reputation, +// deliverability, and other metrics for the domains that you use to send email +// using Amazon Pinpoint. You also gain the ability to perform predictive inbox +// placement tests. // -// When you use the Deliverability dashboard, you pay a monthly charge of USD$1,250.00, -// in addition to any other fees that you accrue by using Amazon Pinpoint. If -// you enable the Deliverability dashboard after the first day of a calendar -// month, we prorate the monthly charge based on how many days have elapsed -// in the current calendar month. +// When you use the Deliverability dashboard, you pay a monthly subscription +// charge, in addition to any other fees that you accrue by using Amazon Pinpoint. +// For more information about the features and cost of a Deliverability dashboard +// subscription, see Amazon Pinpoint Pricing (http://aws.amazon.com/pinpoint/pricing/). // Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/PutDeliverabilityDashboardOptionRequest type PutDeliverabilityDashboardOptionInput struct { _ struct{} `type:"structure"` - // Indicates whether the Deliverability dashboard is enabled. If the value is - // true, then the dashboard is enabled. + // Specifies whether to enable the Deliverability dashboard for your Amazon + // Pinpoint account. To enable the dashboard, set this value to true. // // DashboardEnabled is a required field DashboardEnabled *bool `type:"boolean" required:"true"` + + // An array of objects, one for each verified domain that you use to send email + // and enabled the Deliverability dashboard for. + SubscribedDomains []DomainDeliverabilityTrackingOption `type:"list"` } // String returns the string representation @@ -60,6 +64,18 @@ func (s PutDeliverabilityDashboardOptionInput) MarshalFields(e protocol.FieldEnc metadata := protocol.Metadata{} e.SetValue(protocol.BodyTarget, "DashboardEnabled", protocol.BoolValue(v), metadata) } + if len(s.SubscribedDomains) > 0 { + v := s.SubscribedDomains + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "SubscribedDomains", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddFields(v1) + } + ls0.End() + + } return nil } @@ -85,16 +101,16 @@ const opPutDeliverabilityDashboardOption = "PutDeliverabilityDashboardOption" // PutDeliverabilityDashboardOptionRequest returns a request value for making API operation for // Amazon Pinpoint Email Service. // -// Enable or disable the Deliverability dashboard. When you enable the Deliverability -// dashboard, you gain access to reputation metrics for the domains that you -// use to send email using Amazon Pinpoint. You also gain the ability to perform -// predictive inbox placement tests. +// Enable or disable the Deliverability dashboard for your Amazon Pinpoint account. +// When you enable the Deliverability dashboard, you gain access to reputation, +// deliverability, and other metrics for the domains that you use to send email +// using Amazon Pinpoint. You also gain the ability to perform predictive inbox +// placement tests. // -// When you use the Deliverability dashboard, you pay a monthly charge of USD$1,250.00, -// in addition to any other fees that you accrue by using Amazon Pinpoint. If -// you enable the Deliverability dashboard after the first day of a calendar -// month, we prorate the monthly charge based on how many days have elapsed -// in the current calendar month. +// When you use the Deliverability dashboard, you pay a monthly subscription +// charge, in addition to any other fees that you accrue by using Amazon Pinpoint. +// For more information about the features and cost of a Deliverability dashboard +// subscription, see Amazon Pinpoint Pricing (http://aws.amazon.com/pinpoint/pricing/). // // // Example sending a request using PutDeliverabilityDashboardOptionRequest. // req := client.PutDeliverabilityDashboardOptionRequest(params) diff --git a/service/pinpointemail/api_op_TagResource.go b/service/pinpointemail/api_op_TagResource.go index f16db325b5f..e1ca775facb 100644 --- a/service/pinpointemail/api_op_TagResource.go +++ b/service/pinpointemail/api_op_TagResource.go @@ -105,11 +105,11 @@ const opTagResource = "TagResource" // TagResourceRequest returns a request value for making API operation for // Amazon Pinpoint Email Service. // -// Add one or more tags (keys and values) to one or more specified resources. -// A tag is a label that you optionally define and associate with a resource -// in Amazon Pinpoint. Tags can help you categorize and manage resources in -// different ways, such as by purpose, owner, environment, or other criteria. -// A resource can have as many as 50 tags. +// Add one or more tags (keys and values) to a specified resource. A tag is +// a label that you optionally define and associate with a resource in Amazon +// Pinpoint. Tags can help you categorize and manage resources in different +// ways, such as by purpose, owner, environment, or other criteria. A resource +// can have as many as 50 tags. // // Each tag consists of a required tag key and an associated tag value, both // of which you define. A tag key is a general label that acts as a category diff --git a/service/pinpointemail/api_types.go b/service/pinpointemail/api_types.go index 254c9323ce7..8d0f5d40c68 100644 --- a/service/pinpointemail/api_types.go +++ b/service/pinpointemail/api_types.go @@ -323,7 +323,7 @@ func (s Content) MarshalFields(e protocol.FieldEncoder) error { type DailyVolume struct { _ struct{} `type:"structure"` - // An object that contains inbox placement metrics for a specifid day in the + // An object that contains inbox placement metrics for a specified day in the // analysis period, broken out by the recipient's email provider. DomainIspPlacements []DomainIspPlacement `type:"list"` @@ -679,6 +679,230 @@ func (s DkimAttributes) MarshalFields(e protocol.FieldEncoder) error { return nil } +// An object that contains the deliverability data for a specific campaign. +// This data is available for a campaign only if the campaign sent email by +// using a domain that the Deliverability dashboard is enabled for (PutDeliverabilityDashboardOption +// operation). +// Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DomainDeliverabilityCampaign +type DomainDeliverabilityCampaign struct { + _ struct{} `type:"structure"` + + // The unique identifier for the campaign. Amazon Pinpoint automatically generates + // and assigns this identifier to a campaign. This value is not the same as + // the campaign identifier that Amazon Pinpoint assigns to campaigns that you + // create and manage by using the Amazon Pinpoint API or the Amazon Pinpoint + // console. + CampaignId *string `type:"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 `type:"double"` + + // The major email providers who handled the email message. + Esps []string `type:"list"` + + // 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 `type:"timestamp" timestampFormat:"unix"` + + // The verified email address that the email message was sent from. + FromAddress *string `type:"string"` + + // The URL of an image that contains a snapshot of the email message that was + // sent. + ImageUrl *string `type:"string"` + + // The number of email messages that were delivered to recipients’ inboxes. + InboxCount *int64 `type:"long"` + + // 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 `type:"timestamp" timestampFormat:"unix"` + + // The projected number of recipients that the email message was sent to. + ProjectedVolume *int64 `type:"long"` + + // 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 `type:"double"` + + // 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 `type:"double"` + + // The IP addresses that were used to send the email message. + SendingIps []string `type:"list"` + + // The number of email messages that were delivered to recipients' spam or junk + // mail folders. + SpamCount *int64 `type:"long"` + + // The subject line, or title, of the email message. + Subject *string `type:"string"` +} + +// String returns the string representation +func (s DomainDeliverabilityCampaign) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s DomainDeliverabilityCampaign) MarshalFields(e protocol.FieldEncoder) error { + if s.CampaignId != nil { + v := *s.CampaignId + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "CampaignId", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.DeleteRate != nil { + v := *s.DeleteRate + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "DeleteRate", protocol.Float64Value(v), metadata) + } + if len(s.Esps) > 0 { + v := s.Esps + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "Esps", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddValue(protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ls0.End() + + } + if s.FirstSeenDateTime != nil { + v := *s.FirstSeenDateTime + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "FirstSeenDateTime", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if s.FromAddress != nil { + v := *s.FromAddress + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "FromAddress", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.ImageUrl != nil { + v := *s.ImageUrl + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "ImageUrl", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.InboxCount != nil { + v := *s.InboxCount + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "InboxCount", protocol.Int64Value(v), metadata) + } + if s.LastSeenDateTime != nil { + v := *s.LastSeenDateTime + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "LastSeenDateTime", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + if s.ProjectedVolume != nil { + v := *s.ProjectedVolume + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "ProjectedVolume", protocol.Int64Value(v), metadata) + } + if s.ReadDeleteRate != nil { + v := *s.ReadDeleteRate + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "ReadDeleteRate", protocol.Float64Value(v), metadata) + } + if s.ReadRate != nil { + v := *s.ReadRate + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "ReadRate", protocol.Float64Value(v), metadata) + } + if len(s.SendingIps) > 0 { + v := s.SendingIps + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "SendingIps", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddValue(protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ls0.End() + + } + if s.SpamCount != nil { + v := *s.SpamCount + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "SpamCount", protocol.Int64Value(v), metadata) + } + if s.Subject != nil { + v := *s.Subject + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "Subject", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// An object that contains information about the Deliverability dashboard subscription +// for a verified domain that you use to send email and currently has an active +// Deliverability dashboard subscription. If a Deliverability dashboard subscription +// is active for a domain, you gain access to reputation, inbox placement, and +// other metrics for the domain. +// Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DomainDeliverabilityTrackingOption +type DomainDeliverabilityTrackingOption struct { + _ struct{} `type:"structure"` + + // A verified domain that’s associated with your AWS account and currently + // has an active Deliverability dashboard subscription. + Domain *string `type:"string"` + + // An object that contains information about the inbox placement data settings + // for the domain. + InboxPlacementTrackingOption *InboxPlacementTrackingOption `type:"structure"` + + // The date, in Unix time format, when you enabled the Deliverability dashboard + // for the domain. + SubscriptionStartDate *time.Time `type:"timestamp" timestampFormat:"unix"` +} + +// String returns the string representation +func (s DomainDeliverabilityTrackingOption) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s DomainDeliverabilityTrackingOption) MarshalFields(e protocol.FieldEncoder) error { + if s.Domain != nil { + v := *s.Domain + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "Domain", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + if s.InboxPlacementTrackingOption != nil { + v := s.InboxPlacementTrackingOption + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "InboxPlacementTrackingOption", v, metadata) + } + if s.SubscriptionStartDate != nil { + v := *s.SubscriptionStartDate + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "SubscriptionStartDate", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } + return nil +} + // An object that contains inbox placement data for email sent from one of your // email domains to a specific email provider. // Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/DomainIspPlacement @@ -1098,6 +1322,50 @@ func (s IdentityInfo) MarshalFields(e protocol.FieldEncoder) error { return nil } +// An object that contains information about the inbox placement data settings +// for a verified domain that’s associated with your AWS account. This data +// is available only if you enabled the Deliverability dashboard for the domain +// (PutDeliverabilityDashboardOption operation). +// Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/InboxPlacementTrackingOption +type InboxPlacementTrackingOption struct { + _ struct{} `type:"structure"` + + // Specifies whether inbox placement data is being tracked for the domain. + Global *bool `type:"boolean"` + + // An array of strings, one for each major email provider that the inbox placement + // data applies to. + TrackedIsps []string `type:"list"` +} + +// String returns the string representation +func (s InboxPlacementTrackingOption) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s InboxPlacementTrackingOption) MarshalFields(e protocol.FieldEncoder) error { + if s.Global != nil { + v := *s.Global + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "Global", protocol.BoolValue(v), metadata) + } + if len(s.TrackedIsps) > 0 { + v := s.TrackedIsps + + metadata := protocol.Metadata{} + ls0 := e.List(protocol.BodyTarget, "TrackedIsps", metadata) + ls0.Start() + for _, v1 := range v { + ls0.ListAddValue(protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v1)}) + } + ls0.End() + + } + return nil +} + // An object that describes how email sent during the predictive inbox placement // test was handled by a certain email provider. // Please also see https://docs.aws.amazon.com/goto/WebAPI/pinpoint-email-2018-07-26/IspPlacement @@ -1775,15 +2043,10 @@ func (s SnsDestination) MarshalFields(e protocol.FieldEncoder) error { // Each tag consists of a required tag key and an associated tag value, both // of which you define. A tag key is a general label that acts as a category // for a more specific tag value. A tag value acts as a descriptor within a -// tag key. For example, if you have two versions of an Amazon Pinpoint project, -// one for internal testing and another for external use, you might assign a -// Stack tag key to both projects. The value of the Stack tag key might be Test -// for one project and Production for the other project. -// -// A tag key can contain as many as 128 characters. A tag value can contain -// as many as 256 characters. The characters can be Unicode letters, digits, -// white space, or one of the following symbols: _ . : / = + -. The following -// additional restrictions apply to tags: +// tag key. A tag key can contain as many as 128 characters. A tag value can +// contain as many as 256 characters. The characters can be Unicode letters, +// digits, white space, or one of the following symbols: _ . : / = + -. The +// following additional restrictions apply to tags: // // * Tag keys and values are case sensitive. // diff --git a/service/pinpointemail/pinpointemailiface/interface.go b/service/pinpointemail/pinpointemailiface/interface.go index 9f8f3c46c20..736b31e0426 100644 --- a/service/pinpointemail/pinpointemailiface/interface.go +++ b/service/pinpointemail/pinpointemailiface/interface.go @@ -95,6 +95,8 @@ type ClientAPI interface { GetDeliverabilityTestReportRequest(*pinpointemail.GetDeliverabilityTestReportInput) pinpointemail.GetDeliverabilityTestReportRequest + GetDomainDeliverabilityCampaignRequest(*pinpointemail.GetDomainDeliverabilityCampaignInput) pinpointemail.GetDomainDeliverabilityCampaignRequest + GetDomainStatisticsReportRequest(*pinpointemail.GetDomainStatisticsReportInput) pinpointemail.GetDomainStatisticsReportRequest GetEmailIdentityRequest(*pinpointemail.GetEmailIdentityInput) pinpointemail.GetEmailIdentityRequest @@ -105,6 +107,8 @@ type ClientAPI interface { ListDeliverabilityTestReportsRequest(*pinpointemail.ListDeliverabilityTestReportsInput) pinpointemail.ListDeliverabilityTestReportsRequest + ListDomainDeliverabilityCampaignsRequest(*pinpointemail.ListDomainDeliverabilityCampaignsInput) pinpointemail.ListDomainDeliverabilityCampaignsRequest + ListEmailIdentitiesRequest(*pinpointemail.ListEmailIdentitiesInput) pinpointemail.ListEmailIdentitiesRequest ListTagsForResourceRequest(*pinpointemail.ListTagsForResourceInput) pinpointemail.ListTagsForResourceRequest diff --git a/service/rds/api_op_BacktrackDBCluster.go b/service/rds/api_op_BacktrackDBCluster.go index d189e9d6679..590ff49432d 100644 --- a/service/rds/api_op_BacktrackDBCluster.go +++ b/service/rds/api_op_BacktrackDBCluster.go @@ -48,16 +48,13 @@ type BacktrackDBClusterInput struct { // DBClusterIdentifier is a required field DBClusterIdentifier *string `type:"string" required:"true"` - // A value that indicates whether to force the DB cluster to backtrack when - // binary logging is enabled. Otherwise, an error occurs when binary logging - // is enabled. + // A value that, if specified, forces the DB cluster to backtrack when binary + // logging is enabled. Otherwise, an error occurs when binary logging is enabled. Force *bool `type:"boolean"` - // A value that indicates whether to backtrack the DB cluster to the earliest - // possible backtrack time when BacktrackTo is set to a timestamp earlier than - // the earliest backtrack time. When this parameter is disabled and BacktrackTo - // is set to a timestamp earlier than the earliest backtrack time, an error - // occurs. + // If BacktrackTo is set to a timestamp earlier than the earliest backtrack + // time, this value backtracks the DB cluster to the earliest possible backtrack + // time. Otherwise, an error occurs. UseEarliestTimeOnPointInTimeUnavailable *bool `type:"boolean"` } diff --git a/service/rds/api_op_CopyDBClusterSnapshot.go b/service/rds/api_op_CopyDBClusterSnapshot.go index e860b5fc314..24182baf4c7 100644 --- a/service/rds/api_op_CopyDBClusterSnapshot.go +++ b/service/rds/api_op_CopyDBClusterSnapshot.go @@ -13,8 +13,8 @@ import ( type CopyDBClusterSnapshotInput struct { _ struct{} `type:"structure"` - // A value that indicates whether to copy all tags from the source DB cluster - // snapshot to the target DB cluster snapshot. By default, tags are not copied. + // 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 `type:"boolean"` // DestinationRegion is used for presigning the request to a given region. diff --git a/service/rds/api_op_CopyDBSnapshot.go b/service/rds/api_op_CopyDBSnapshot.go index 4d1e0d3f881..a425bf4bae1 100644 --- a/service/rds/api_op_CopyDBSnapshot.go +++ b/service/rds/api_op_CopyDBSnapshot.go @@ -13,8 +13,8 @@ import ( type CopyDBSnapshotInput struct { _ struct{} `type:"structure"` - // A value that indicates whether to copy all tags from the source DB snapshot - // to the target DB snapshot. By default, tags are not copied. + // True to copy all tags from the source DB snapshot to the target DB snapshot, + // and otherwise false. The default is false. CopyTags *bool `type:"boolean"` // DestinationRegion is used for presigning the request to a given region. diff --git a/service/rds/api_op_CreateDBCluster.go b/service/rds/api_op_CreateDBCluster.go index c6903408e1d..48b8a9a2274 100644 --- a/service/rds/api_op_CreateDBCluster.go +++ b/service/rds/api_op_CreateDBCluster.go @@ -43,8 +43,8 @@ type CreateDBClusterInput struct { // specified CharacterSet. CharacterSetName *string `type:"string"` - // A value that indicates whether to copy all tags from the DB cluster to snapshots - // of the DB cluster. The default is not to copy them. + // True to copy all tags from the DB cluster to snapshots of the DB cluster, + // and otherwise false. The default is false. CopyTagsToSnapshot *bool `type:"boolean"` // The DB cluster identifier. This parameter is stored as a lowercase string. @@ -84,9 +84,9 @@ type CreateDBClusterInput struct { // you are creating. DatabaseName *string `type:"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. + // Indicates whether the DB cluster should have deletion protection enabled. + // The database can't be deleted when this value is set to true. The default + // is false. DeletionProtection *bool `type:"boolean"` // DestinationRegion is used for presigning the request to a given region. @@ -98,8 +98,10 @@ type CreateDBClusterInput struct { // in the Amazon Aurora User Guide. EnableCloudwatchLogsExports []string `type:"list"` - // A value that indicates whether to enable mapping of AWS Identity and Access - // Management (IAM) accounts to database accounts. By default, mapping is disabled. + // True to enable mapping of AWS Identity and Access Management (IAM) accounts + // to database accounts, and otherwise false. + // + // Default: false EnableIAMDatabaseAuthentication *bool `type:"boolean"` // The name of the database engine to be used for this DB cluster. @@ -142,7 +144,7 @@ type CreateDBClusterInput struct { // Amazon RDS will use the encryption key used to encrypt the source. Otherwise, // Amazon RDS will use your default encryption key. // - // * If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier + // * If the StorageEncrypted parameter is true and ReplicationSourceIdentifier // is not specified, then Amazon RDS will use your default encryption key. // // AWS KMS creates the default encryption key for your AWS account. Your AWS @@ -261,7 +263,7 @@ type CreateDBClusterInput struct { // have the same region as the source ARN. SourceRegion *string `type:"string" ignore:"true"` - // A value that indicates whether the DB cluster is encrypted. + // Specifies whether the DB cluster is encrypted. StorageEncrypted *bool `type:"boolean"` // Tags to assign to the DB cluster. diff --git a/service/rds/api_op_CreateDBInstance.go b/service/rds/api_op_CreateDBInstance.go index f6039b6232b..4b3cda42115 100644 --- a/service/rds/api_op_CreateDBInstance.go +++ b/service/rds/api_op_CreateDBInstance.go @@ -27,9 +27,9 @@ type CreateDBInstanceInput struct { // // Constraints to the amount of storage for each storage type are the following: // - // * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + // * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768. // - // * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + // * Provisioned IOPS storage (io1): Must be an integer from 100 to 32768. // // * Magnetic storage (standard): Must be an integer from 5 to 3072. // @@ -37,9 +37,9 @@ type CreateDBInstanceInput struct { // // Constraints to the amount of storage for each storage type are the following: // - // * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + // * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768. // - // * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + // * Provisioned IOPS storage (io1): Must be an integer from 100 to 32768. // // * Magnetic storage (standard): Must be an integer from 5 to 3072. // @@ -47,9 +47,9 @@ type CreateDBInstanceInput struct { // // Constraints to the amount of storage for each storage type are the following: // - // * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + // * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768. // - // * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + // * Provisioned IOPS storage (io1): Must be an integer from 100 to 32768. // // * Magnetic storage (standard): Must be an integer from 5 to 3072. // @@ -57,9 +57,9 @@ type CreateDBInstanceInput struct { // // Constraints to the amount of storage for each storage type are the following: // - // * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + // * General Purpose (SSD) storage (gp2): Must be an integer from 20 to 32768. // - // * Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + // * Provisioned IOPS storage (io1): Must be an integer from 100 to 32768. // // * Magnetic storage (standard): Must be an integer from 10 to 3072. // @@ -80,9 +80,10 @@ type CreateDBInstanceInput struct { // from 20 to 1024. AllocatedStorage *int64 `type:"integer"` - // 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 applied automatically. + // Indicates that minor engine upgrades are applied automatically to the DB + // instance during the maintenance window. + // + // Default: true AutoMinorVersionUpgrade *bool `type:"boolean"` // The Availability Zone (AZ) where the database will be created. For information @@ -94,8 +95,8 @@ type CreateDBInstanceInput struct { // // Example: us-east-1d // - // Constraint: The AvailabilityZone parameter can't be specified if the DB instance - // is a Multi-AZ deployment. The specified Availability Zone must be in the + // 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 `type:"string"` @@ -126,8 +127,8 @@ type CreateDBInstanceInput struct { // information, see CreateDBCluster. CharacterSetName *string `type:"string"` - // A value that indicates whether to copy tags from the DB instance to snapshots - // of the DB instance. By default, tags are not copied. + // True to copy all tags from the DB instance to snapshots of the DB instance, + // and otherwise false. The default is false. // // Amazon Aurora // @@ -254,10 +255,9 @@ type CreateDBInstanceInput struct { // If there is no DB subnet group, then it is a non-VPC DB instance. DBSubnetGroupName *string `type:"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. For more information, see Deleting a DB - // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + // Indicates if the DB instance should have deletion protection enabled. The + // database can't be deleted when this value is set to true. The default is + // false. For more information, see Deleting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). DeletionProtection *bool `type:"boolean"` // For an Amazon RDS DB instance that's running Microsoft SQL Server, this parameter @@ -278,8 +278,8 @@ type CreateDBInstanceInput struct { // in the Amazon Relational Database Service User Guide. EnableCloudwatchLogsExports []string `type:"list"` - // A value that indicates whether to enable mapping of AWS Identity and Access - // Management (IAM) accounts to database accounts. By default, mapping is disabled. + // 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: // @@ -293,10 +293,11 @@ type CreateDBInstanceInput struct { // * For MySQL 5.6, minor version 5.6.34 or higher // // * For MySQL 5.7, minor version 5.7.16 or higher + // + // Default: false EnableIAMDatabaseAuthentication *bool `type:"boolean"` - // A value that indicates whether to enable Performance Insights for the DB - // instance. + // True to enable Performance Insights for the DB instance, and otherwise false. // // 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. @@ -400,10 +401,10 @@ type CreateDBInstanceInput struct { // Not applicable. The KMS key identifier is managed by the DB cluster. For // more information, see CreateDBCluster. // - // If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId - // parameter, then Amazon RDS will use 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. + // If the StorageEncrypted parameter is true, and you do not specify a value + // for the KmsKeyId parameter, then Amazon RDS will use 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. KmsKeyId *string `type:"string"` // License model information for this DB instance. @@ -524,9 +525,9 @@ type CreateDBInstanceInput struct { // a MonitoringRoleArn value. MonitoringRoleArn *string `type:"string"` - // A value that indicates whether the DB instance is a Multi-AZ deployment. - // You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ - // deployment. + // A value that specifies whether 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 `type:"boolean"` // Indicates that the DB instance should be associated with the specified option @@ -540,11 +541,6 @@ type CreateDBInstanceInput struct { // 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. - // - // 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 `type:"string"` // The amount of time, in days, to retain Performance Insights data. Valid values @@ -653,11 +649,10 @@ type CreateDBInstanceInput struct { // Valid Values: 0 - 15 PromotionTier *int64 `type:"integer"` - // A value that indicates whether the DB instance is publicly accessible. When - // the DB instance is publicly accessible, it is an Internet-facing instance - // with a publicly resolvable DNS name, which resolves to a public IP address. - // When the DB instance is not publicly accessible, it is an internal instance - // with a DNS name that resolves to a private IP address. + // 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. // // Default: The default behavior varies depending on whether DBSubnetGroupName // is specified. @@ -681,12 +676,13 @@ type CreateDBInstanceInput struct { // to it, the DB instance is public. PubliclyAccessible *bool `type:"boolean"` - // A value that indicates whether the DB instance is encrypted. By default, - // it is not encrypted. + // Specifies whether the DB instance is encrypted. // // Amazon Aurora // // Not applicable. The encryption for DB instances is managed by the DB cluster. + // + // Default: false StorageEncrypted *bool `type:"boolean"` // Specifies the storage type to be associated with the DB instance. @@ -695,7 +691,7 @@ type CreateDBInstanceInput struct { // // If you specify io1, you must also include a value for the Iops parameter. // - // Default: io1 if the Iops parameter is specified, otherwise gp2 + // Default: io1 if the Iops parameter is specified, otherwise standard StorageType *string `type:"string"` // Tags to assign to the DB instance. diff --git a/service/rds/api_op_CreateDBInstanceReadReplica.go b/service/rds/api_op_CreateDBInstanceReadReplica.go index 4151fb9ad61..b9d58852774 100644 --- a/service/rds/api_op_CreateDBInstanceReadReplica.go +++ b/service/rds/api_op_CreateDBInstanceReadReplica.go @@ -13,8 +13,8 @@ import ( type CreateDBInstanceReadReplicaInput struct { _ struct{} `type:"structure"` - // A value that indicates whether minor engine upgrades are applied automatically - // to the Read Replica during the maintenance window. + // Indicates that minor engine upgrades are applied automatically to the Read + // Replica during the maintenance window. // // Default: Inherits from the source DB instance AutoMinorVersionUpgrade *bool `type:"boolean"` @@ -27,8 +27,8 @@ type CreateDBInstanceReadReplicaInput struct { // Example: us-east-1d AvailabilityZone *string `type:"string"` - // A value that indicates whether to copy all tags from the Read Replica to - // snapshots of the Read Replica. By default, tags are not copied. + // True to copy all tags from the Read Replica to snapshots of the Read Replica, + // and otherwise false. The default is false. CopyTagsToSnapshot *bool `type:"boolean"` // The compute and memory capacity of the Read Replica, for example, db.m4.large. @@ -69,10 +69,9 @@ type CreateDBInstanceReadReplicaInput struct { // Example: mySubnetgroup DBSubnetGroupName *string `type:"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. For more information, see Deleting a DB - // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + // Indicates if the DB instance should have deletion protection enabled. The + // database can't be deleted when this value is set to true. The default is + // false. For more information, see Deleting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). DeletionProtection *bool `type:"boolean"` // DestinationRegion is used for presigning the request to a given region. @@ -84,8 +83,8 @@ type CreateDBInstanceReadReplicaInput struct { // in the Amazon RDS User Guide. EnableCloudwatchLogsExports []string `type:"list"` - // A value that indicates whether to enable mapping of AWS Identity and Access - // Management (IAM) accounts to database accounts. By default, mapping is disabled. + // 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 // @@ -94,10 +93,11 @@ type CreateDBInstanceReadReplicaInput struct { // * For MySQL 5.7, minor version 5.7.16 or higher // // * Aurora MySQL 5.6 or higher + // + // Default: false EnableIAMDatabaseAuthentication *bool `type:"boolean"` - // A value that indicates whether to enable Performance Insights for the Read - // Replica. + // True to enable Performance Insights for the Read Replica, and otherwise false. // // For more information, see Using Amazon Performance Insights (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) // in the Amazon RDS User Guide. @@ -143,7 +143,7 @@ type CreateDBInstanceReadReplicaInput struct { // a MonitoringRoleArn value. MonitoringRoleArn *string `type:"string"` - // A value that indicates whether the Read Replica is in a Multi-AZ deployment. + // Specifies whether the Read Replica is in a Multi-AZ deployment. // // You can create a Read Replica as a Multi-AZ DB instance. RDS creates a standby // of your replica in another Availability Zone for failover support for the @@ -158,11 +158,6 @@ type CreateDBInstanceReadReplicaInput struct { // 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. - // - // 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 `type:"string"` // The amount of time, in days, to retain Performance Insights data. Valid values @@ -220,12 +215,11 @@ type CreateDBInstanceReadReplicaInput struct { // class of the DB instance. ProcessorFeatures []ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"` - // A value that indicates whether the DB instance is publicly accessible. When - // the DB instance is publicly accessible, it is an Internet-facing instance - // with a publicly resolvable DNS name, which resolves to a public IP address. - // When the DB instance is not publicly accessible, it is an internal instance - // with a DNS name that resolves to a private IP address. For more information, - // see CreateDBInstance. + // 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. For more + // information, see CreateDBInstance. PubliclyAccessible *bool `type:"boolean"` // The identifier of the DB instance that will act as the source for the Read @@ -272,14 +266,14 @@ type CreateDBInstanceReadReplicaInput struct { // // If you specify io1, you must also include a value for the Iops parameter. // - // Default: io1 if the Iops parameter is specified, otherwise gp2 + // Default: io1 if the Iops parameter is specified, otherwise standard StorageType *string `type:"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 []Tag `locationNameList:"Tag" type:"list"` - // A value that indicates whether the DB instance class of the DB instance uses + // A value that specifies that the DB instance class of the DB instance uses // its default processor features. UseDefaultProcessorFeatures *bool `type:"boolean"` diff --git a/service/rds/api_op_CreateEventSubscription.go b/service/rds/api_op_CreateEventSubscription.go index c54499c2825..b3dd5cea5d0 100644 --- a/service/rds/api_op_CreateEventSubscription.go +++ b/service/rds/api_op_CreateEventSubscription.go @@ -13,9 +13,8 @@ import ( type CreateEventSubscriptionInput struct { _ struct{} `type:"structure"` - // A value that indicates whether to activate the subscription. If the event - // notification subscription is not activated, the subscription is created but - // not active. + // A Boolean value; set to true to activate the subscription, set to false to + // create the subscription but not active it. Enabled *bool `type:"boolean"` // A list of event categories for a SourceType that you want to subscribe to. diff --git a/service/rds/api_op_CreateGlobalCluster.go b/service/rds/api_op_CreateGlobalCluster.go index 4c404754d23..a0122ef6ec8 100644 --- a/service/rds/api_op_CreateGlobalCluster.go +++ b/service/rds/api_op_CreateGlobalCluster.go @@ -19,7 +19,7 @@ type CreateGlobalClusterInput struct { DatabaseName *string `type:"string"` // The deletion protection setting for the new global database. The global database - // can't be deleted when deletion protection is enabled. + // can't be deleted when this value is set to true. DeletionProtection *bool `type:"boolean"` // Provides the name of the database engine to be used for this DB cluster. diff --git a/service/rds/api_op_DeleteDBCluster.go b/service/rds/api_op_DeleteDBCluster.go index 2fec7b830a2..7247717011f 100644 --- a/service/rds/api_op_DeleteDBCluster.go +++ b/service/rds/api_op_DeleteDBCluster.go @@ -24,10 +24,10 @@ type DeleteDBClusterInput struct { DBClusterIdentifier *string `type:"string" required:"true"` // The DB cluster snapshot identifier of the new DB cluster snapshot created - // when SkipFinalSnapshot is disabled. + // when SkipFinalSnapshot is set to false. // - // Specifying this parameter and also skipping the creation of a final DB cluster - // snapshot with the SkipFinalShapshot parameter results in an error. + // Specifying this parameter and also setting the SkipFinalShapshot parameter + // to true results in an error. // // Constraints: // @@ -38,14 +38,14 @@ type DeleteDBClusterInput struct { // * Can't end with a hyphen or contain two consecutive hyphens FinalDBSnapshotIdentifier *string `type:"string"` - // A value that indicates whether to skip the creation of a final DB cluster - // snapshot before the DB cluster is deleted. If skip is specified, no DB cluster - // snapshot is created. If skip is not specified, a DB cluster snapshot is created - // before the DB cluster is deleted. By default, skip is not specified, and - // the DB cluster snapshot is created. By default, this parameter is disabled. + // 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 disabled. + // is false. + // + // Default: false SkipFinalSnapshot *bool `type:"boolean"` } diff --git a/service/rds/api_op_DeleteDBInstance.go b/service/rds/api_op_DeleteDBInstance.go index 2724cb3ae34..1521f24861c 100644 --- a/service/rds/api_op_DeleteDBInstance.go +++ b/service/rds/api_op_DeleteDBInstance.go @@ -24,15 +24,15 @@ type DeleteDBInstanceInput struct { DBInstanceIdentifier *string `type:"string" required:"true"` // A value that indicates whether to remove automated backups immediately after - // the DB instance is deleted. This parameter isn't case-sensitive. The default - // is to remove automated backups immediately after the DB instance is deleted. + // the DB instance is deleted. This parameter isn't case-sensitive. This parameter + // defaults to true. DeleteAutomatedBackups *bool `type:"boolean"` - // The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot - // parameter is disabled. + // The DBSnapshotIdentifier of the new DB snapshot created when SkipFinalSnapshot + // is set to false. // - // Specifying this parameter and also specifying to skip final DB snapshot creation - // in SkipFinalShapshot results in an error. + // Specifying this parameter and also setting the SkipFinalShapshot parameter + // to true results in an error. // // Constraints: // @@ -45,20 +45,21 @@ type DeleteDBInstanceInput struct { // * Can't be specified when deleting a Read Replica. FinalDBSnapshotIdentifier *string `type:"string"` - // A value that indicates whether to skip the creation of a final DB snapshot - // before the DB instance is deleted. If skip is specified, no DB snapshot is - // created. If skip is not specified, a DB snapshot is created before the DB - // instance is deleted. By default, skip is not specified, and the DB snapshot - // is created. + // A value that indicates whether a final DB snapshot is created before the + // DB instance is deleted. If true is specified, no DB snapshot is created. + // If false is specified, a DB snapshot is created before the DB instance is + // deleted. // - // Note that when a DB instance is in a failure state and has a status of 'failed', - // 'incompatible-restore', or 'incompatible-network', it can only be deleted - // when skip is specified. + // When a DB instance is in a failure state and has a status of failed, incompatible-restore, + // or incompatible-network, you can only delete it when the SkipFinalSnapshot + // parameter is set to true. // - // Specify skip when deleting a Read Replica. + // Specify true when deleting a Read Replica. // - // The FinalDBSnapshotIdentifier parameter must be specified if skip is not - // specified. + // The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot + // is false. + // + // Default: false SkipFinalSnapshot *bool `type:"boolean"` } @@ -113,7 +114,7 @@ const opDeleteDBInstance = "DeleteDBInstance" // // Note that when a DB instance is in a failure state and has a status of failed, // incompatible-restore, or incompatible-network, you can only delete it when -// you skip creation of the final snapshot with the SkipFinalSnapshot parameter. +// the SkipFinalSnapshot parameter is set to true. // // If the specified DB instance is part of an Amazon Aurora DB cluster, you // can't delete the DB instance if both of the following conditions are true: diff --git a/service/rds/api_op_DescribeDBClusterSnapshots.go b/service/rds/api_op_DescribeDBClusterSnapshots.go index 1d897839fc0..49abe9c10d9 100644 --- a/service/rds/api_op_DescribeDBClusterSnapshots.go +++ b/service/rds/api_op_DescribeDBClusterSnapshots.go @@ -38,17 +38,17 @@ type DescribeDBClusterSnapshotsInput struct { // This parameter is not currently supported. Filters []Filter `locationNameList:"Filter" type:"list"` - // A value that indicates whether to include manual DB cluster snapshots that - // are public and can be copied or restored by any AWS account. By default, - // the public snapshots are not included. + // 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 `type:"boolean"` - // A value that indicates whether to include shared manual DB cluster snapshots - // from other AWS accounts that this AWS account has been given permission to - // copy or restore. By default, these snapshots are not included. + // 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 manual DB cluster snapshot // from another AWS account by the ModifyDBClusterSnapshotAttribute API action. @@ -84,9 +84,9 @@ type DescribeDBClusterSnapshotsInput struct { // // If you don't specify a SnapshotType value, then both automated and manual // DB cluster snapshots are returned. You can include shared DB cluster snapshots - // with these results by enabling the IncludeShared parameter. You can include - // public DB cluster snapshots with these results by enabling the IncludePublic - // parameter. + // with these results by setting the IncludeShared parameter to true. You can + // include public DB cluster snapshots with these results by setting the IncludePublic + // parameter to true. // // The IncludeShared and IncludePublic parameters don't apply for SnapshotType // values of manual or automated. The IncludePublic parameter doesn't apply diff --git a/service/rds/api_op_DescribeDBEngineVersions.go b/service/rds/api_op_DescribeDBEngineVersions.go index f2165a856de..95cd848ade9 100644 --- a/service/rds/api_op_DescribeDBEngineVersions.go +++ b/service/rds/api_op_DescribeDBEngineVersions.go @@ -21,8 +21,8 @@ type DescribeDBEngineVersionsInput struct { // * If supplied, must match an existing DBParameterGroupFamily. DBParameterGroupFamily *string `type:"string"` - // A value that indicates whether only the default version of the specified - // engine or engine and major version combination is returned. + // Indicates that only the default version of the specified engine or engine + // and major version combination is returned. DefaultOnly *bool `type:"boolean"` // The database engine to return. @@ -36,18 +36,16 @@ type DescribeDBEngineVersionsInput struct { // This parameter is not currently supported. Filters []Filter `locationNameList:"Filter" type:"list"` - // A value that indicates whether to list the supported character sets for each - // engine version. - // - // If this parameter is enabled and the requested engine supports the CharacterSetName + // Whether to include non-available engine versions in the list. The default + // is to list only available engine versions. + IncludeAll *bool `type:"boolean"` + + // 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:"boolean"` - // A value that indicates whether to list the supported time zones for each - // engine version. - // - // If this parameter is enabled and the requested engine supports the TimeZone + // 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 `type:"boolean"` diff --git a/service/rds/api_op_DescribeDBSnapshots.go b/service/rds/api_op_DescribeDBSnapshots.go index ab4b98a6aa0..17f487ad599 100644 --- a/service/rds/api_op_DescribeDBSnapshots.go +++ b/service/rds/api_op_DescribeDBSnapshots.go @@ -41,17 +41,16 @@ type DescribeDBSnapshotsInput struct { // This parameter is not currently supported. Filters []Filter `locationNameList:"Filter" type:"list"` - // A value that indicates whether to include manual DB cluster snapshots that - // are public and can be copied or restored by any AWS account. By default, - // the public snapshots are not included. + // True to include manual DB snapshots that are public and can be copied or + // restored by any AWS account, and otherwise false. The default is false. // // You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute // API. IncludePublic *bool `type:"boolean"` - // A value that indicates whether to include shared manual DB cluster snapshots - // from other AWS accounts that this AWS account has been given permission to - // copy or restore. By default, these snapshots are not included. + // True to include shared manual DB 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 manual DB snapshot from // another AWS account by using the ModifyDBSnapshotAttribute API action. @@ -92,8 +91,8 @@ type DescribeDBSnapshotsInput struct { // If you don't specify a SnapshotType value, then both automated and manual // snapshots are returned. Shared and public DB snapshots are not included in // the returned results by default. You can include shared snapshots with these - // results by enabling the IncludeShared parameter. You can include public snapshots - // with these results by enabling the IncludePublic parameter. + // results by setting the IncludeShared parameter to true. You can include public + // snapshots with these results by setting the IncludePublic parameter to true. // // The IncludeShared and IncludePublic parameters don't apply for SnapshotType // values of manual or automated. The IncludePublic parameter doesn't apply diff --git a/service/rds/api_op_DescribeOrderableDBInstanceOptions.go b/service/rds/api_op_DescribeOrderableDBInstanceOptions.go index 4a03f2d834f..5403844b531 100644 --- a/service/rds/api_op_DescribeOrderableDBInstanceOptions.go +++ b/service/rds/api_op_DescribeOrderableDBInstanceOptions.go @@ -48,7 +48,8 @@ type DescribeOrderableDBInstanceOptionsInput struct { // Constraints: Minimum 20, maximum 100. MaxRecords *int64 `type:"integer"` - // A value that indicates whether to show only VPC or non-VPC offerings. + // The VPC filter value. Specify this parameter to show only the available VPC + // or non-VPC offerings. Vpc *bool `type:"boolean"` } diff --git a/service/rds/api_op_DescribeReservedDBInstances.go b/service/rds/api_op_DescribeReservedDBInstances.go index f00472248be..e363a290b1e 100644 --- a/service/rds/api_op_DescribeReservedDBInstances.go +++ b/service/rds/api_op_DescribeReservedDBInstances.go @@ -41,8 +41,8 @@ type DescribeReservedDBInstancesInput struct { // Constraints: Minimum 20, maximum 100. MaxRecords *int64 `type:"integer"` - // A value that indicates whether to show only those reservations that support - // Multi-AZ. + // The Multi-AZ filter value. Specify this parameter to show only those reservations + // matching the specified Multi-AZ parameter. MultiAZ *bool `type:"boolean"` // The offering type filter value. Specify this parameter to show only the available diff --git a/service/rds/api_op_DescribeReservedDBInstancesOfferings.go b/service/rds/api_op_DescribeReservedDBInstancesOfferings.go index 049a03c475a..bc0bfb30afe 100644 --- a/service/rds/api_op_DescribeReservedDBInstancesOfferings.go +++ b/service/rds/api_op_DescribeReservedDBInstancesOfferings.go @@ -41,8 +41,8 @@ type DescribeReservedDBInstancesOfferingsInput struct { // Constraints: Minimum 20, maximum 100. MaxRecords *int64 `type:"integer"` - // A value that indicates whether to show only those reservations that support - // Multi-AZ. + // The Multi-AZ filter value. Specify this parameter to show only the available + // offerings matching the specified Multi-AZ parameter. MultiAZ *bool `type:"boolean"` // The offering type filter value. Specify this parameter to show only the available diff --git a/service/rds/api_op_ModifyCurrentDBClusterCapacity.go b/service/rds/api_op_ModifyCurrentDBClusterCapacity.go index bdc990ed4c6..f85208cd11b 100644 --- a/service/rds/api_op_ModifyCurrentDBClusterCapacity.go +++ b/service/rds/api_op_ModifyCurrentDBClusterCapacity.go @@ -20,7 +20,7 @@ type ModifyCurrentDBClusterCapacityInput struct { // // Constraints: // - // * Value must be 1, 2, 4, 8, 16, 32, 64, 128, or 256. + // * Value must be 2, 4, 8, 16, 32, 64, 128, or 256. Capacity *int64 `type:"integer"` // The DB cluster identifier for the cluster being modified. This parameter diff --git a/service/rds/api_op_ModifyDBCluster.go b/service/rds/api_op_ModifyDBCluster.go index d71106dc000..89b8b0ebc09 100644 --- a/service/rds/api_op_ModifyDBCluster.go +++ b/service/rds/api_op_ModifyDBCluster.go @@ -13,20 +13,20 @@ import ( type ModifyDBClusterInput struct { _ struct{} `type:"structure"` - // A value that indicates whether the modifications in this request and any + // 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 disabled, changes to the DB cluster are applied during the next maintenance + // is set to false, changes to the DB cluster are applied during the next maintenance // window. // // The ApplyImmediately parameter only affects the EnableIAMDatabaseAuthentication, - // MasterUserPassword, and NewDBClusterIdentifier values. If the ApplyImmediately - // parameter is disabled, then changes to the EnableIAMDatabaseAuthentication, + // MasterUserPassword, and NewDBClusterIdentifier values. If you set the ApplyImmediately + // parameter value to false, then changes to the EnableIAMDatabaseAuthentication, // MasterUserPassword, and NewDBClusterIdentifier values are applied during // the next maintenance window. All other changes are applied immediately, regardless // of the value of the ApplyImmediately parameter. // - // By default, this parameter is disabled. + // Default: false ApplyImmediately *bool `type:"boolean"` // The target backtrack window, in seconds. To disable backtracking, set this @@ -54,8 +54,8 @@ type ModifyDBClusterInput struct { // Logs for a specific DB cluster. CloudwatchLogsExportConfiguration *CloudwatchLogsExportConfiguration `type:"structure"` - // A value that indicates whether to copy all tags from the DB cluster to snapshots - // of the DB cluster. The default is not to copy them. + // True to copy all tags from the DB cluster to snapshots of the DB cluster, + // and otherwise false. The default is false. CopyTagsToSnapshot *bool `type:"boolean"` // The DB cluster identifier for the cluster being modified. This parameter @@ -71,9 +71,8 @@ type ModifyDBClusterInput struct { // The name of the DB cluster parameter group to use for the DB cluster. DBClusterParameterGroupName *string `type:"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. + // Indicates if the DB cluster has deletion protection enabled. The database + // can't be deleted when this value is set to true. DeletionProtection *bool `type:"boolean"` // @@ -92,15 +91,17 @@ type ModifyDBClusterInput struct { // in the Amazon Aurora User Guide. EnableHttpEndpoint *bool `type:"boolean"` - // A value that indicates whether to enable mapping of AWS Identity and Access - // Management (IAM) accounts to database accounts. By default, mapping is disabled. + // True to enable mapping of AWS Identity and Access Management (IAM) accounts + // to database accounts, and otherwise false. + // + // Default: false EnableIAMDatabaseAuthentication *bool `type:"boolean"` // 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 - // maintenance window unless ApplyImmediately is enabled. + // maintenance window unless the ApplyImmediately parameter is set to true. // - // For a list of valid engine versions, use DescribeDBEngineVersions. + // For a list of valid engine versions, use the DescribeDBEngineVersions action. EngineVersion *string `type:"string"` // The new password for the master database user. This password can contain @@ -126,10 +127,10 @@ type ModifyDBClusterInput struct { // A value that indicates that the DB cluster should be associated with the // specified option group. Changing this parameter doesn't result in an outage // except in the following case, and the change is applied during the next maintenance - // window unless the ApplyImmediately is enabled for this request. If the parameter - // change results in an option group that enables OEM, this change can cause - // a brief (sub-second) period during which new connections are rejected but - // existing connections are not interrupted. + // window unless the ApplyImmediately parameter is set to true for this request. + // If the parameter change results in an option group that enables OEM, this + // change can cause a brief (sub-second) period during which new connections + // are rejected but existing connections are not interrupted. // // Permanent options can't be removed from an option group. The option group // can't be removed from a DB cluster once it is associated with a DB cluster. diff --git a/service/rds/api_op_ModifyDBInstance.go b/service/rds/api_op_ModifyDBInstance.go index bb520fdb3ff..7b00b08f7af 100644 --- a/service/rds/api_op_ModifyDBInstance.go +++ b/service/rds/api_op_ModifyDBInstance.go @@ -23,34 +23,36 @@ type ModifyDBInstanceInput struct { // For the valid values for allocated storage for each engine, see CreateDBInstance. AllocatedStorage *int64 `type:"integer"` - // A value that indicates whether major version upgrades are allowed. Changing - // this parameter doesn't result in an outage and the change is asynchronously - // applied as soon as possible. + // 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. // - // Constraints: Major version upgrades must be allowed when specifying a value - // for the EngineVersion parameter that is a different major version than the - // DB instance's current version. + // Constraints: This parameter must be set to true when specifying a value for + // the EngineVersion parameter that is a different major version than the DB + // instance's current version. AllowMajorVersionUpgrade *bool `type:"boolean"` - // A value that indicates 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. By default, - // this parameter is disabled. - // - // If this parameter is disabled, 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. - // Review the table of parameters in Modifying a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html) - // in the Amazon RDS User Guide. to see the impact of enabling or disabling - // ApplyImmediately for each modified parameter and to determine when the changes - // are applied. + // 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. Review the table of parameters in Modifying a DB Instance and Using + // the Apply Immediately Parameter (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html) + // in the Amazon RDS User Guide. to see the impact that setting ApplyImmediately + // to true or false has for each modified parameter and to determine when the + // changes are applied. + // + // Default: false ApplyImmediately *bool `type:"boolean"` - // A value that indicates whether 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 results if this parameter - // is enabled during the maintenance window, and a newer minor version is available, + // 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 RDS has enabled auto patching for that engine version. AutoMinorVersionUpgrade *bool `type:"boolean"` @@ -60,9 +62,10 @@ type ModifyDBInstanceInput struct { // // Changing this parameter can result in an outage if you change from 0 to a // non-zero value or from a non-zero value to 0. These changes are applied during - // the next maintenance window unless the ApplyImmediately parameter is enabled - // for this request. If you change the parameter from one non-zero value to - // another non-zero value, the change is asynchronously applied as soon as possible. + // the next maintenance window unless the ApplyImmediately parameter is set + // to true for this request. If you change the parameter from one non-zero value + // to another non-zero value, the change is asynchronously applied as soon as + // possible. // // Amazon Aurora // @@ -95,8 +98,8 @@ type ModifyDBInstanceInput struct { // has no effect. CloudwatchLogsExportConfiguration *CloudwatchLogsExportConfiguration `type:"structure"` - // 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. + // True to copy all tags from the DB instance to snapshots of the DB instance, + // and otherwise false. The default is false. // // Amazon Aurora // @@ -113,7 +116,7 @@ type ModifyDBInstanceInput struct { // // If you modify the DB instance class, an outage occurs during the change. // The change is applied during the next maintenance window, unless ApplyImmediately - // is enabled for this request. + // is specified as true for this request. // // Default: Uses existing setting DBInstanceClass *string `type:"string"` @@ -204,17 +207,17 @@ type ModifyDBInstanceInput struct { // in the Amazon RDS User Guide. // // Changing the subnet group causes an outage during the change. The change - // is applied during the next maintenance window, unless you enable ApplyImmediately. + // is applied during the next maintenance window, unless you specify true for + // the ApplyImmediately parameter. // // Constraints: If supplied, must match the name of an existing DBSubnetGroup. // // Example: mySubnetGroup DBSubnetGroupName *string `type:"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. For more information, see Deleting a DB - // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + // Indicates if the DB instance has deletion protection enabled. The database + // can't be deleted when this value is set to true. For more information, see + // Deleting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). DeletionProtection *bool `type:"boolean"` // The Active Directory Domain to move the instance to. Specify none to remove @@ -226,8 +229,8 @@ type ModifyDBInstanceInput struct { // The name of the IAM role to use when making API calls to the Directory Service. DomainIAMRoleName *string `type:"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. + // 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 // @@ -241,10 +244,11 @@ type ModifyDBInstanceInput struct { // * For MySQL 5.6, minor version 5.6.34 or higher // // * For MySQL 5.7, minor version 5.7.16 or higher + // + // Default: false EnableIAMDatabaseAuthentication *bool `type:"boolean"` - // A value that indicates whether to enable Performance Insights for the DB - // instance. + // True to enable Performance Insights for the DB instance, and otherwise false. // // 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. @@ -252,7 +256,7 @@ type ModifyDBInstanceInput struct { // The version number of the database engine to upgrade to. Changing this parameter // results in an outage and the change is applied during the next maintenance - // window unless the ApplyImmediately parameter is eanbled for this request. + // window unless the ApplyImmediately parameter is set to true for this request. // // For major version upgrades, if a nondefault DB parameter group is currently // in use, a new DB parameter group in the DB parameter group family for the @@ -267,9 +271,9 @@ type ModifyDBInstanceInput struct { // // Changing this setting doesn't result in an outage and the change is applied // during the next maintenance window unless the ApplyImmediately parameter - // is enabled for this request. If you are migrating from Provisioned IOPS to - // standard storage, set this value to 0. The DB instance will require a reboot - // for the change in storage type to take effect. + // is set to true for this request. If you are migrating from Provisioned IOPS + // to standard storage, set this value to 0. The DB instance will require a + // reboot for the change in storage type to take effect. // // If you choose to migrate your DB instance from using standard storage to // using Provisioned IOPS, or from using Provisioned IOPS to using standard @@ -357,17 +361,16 @@ type ModifyDBInstanceInput struct { // a MonitoringRoleArn value. MonitoringRoleArn *string `type:"string"` - // A value that indicates whether 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 enabled for this request. + // 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 `type:"boolean"` // The new DB instance identifier for the DB instance when renaming a DB instance. - // When you change the DB instance identifier, an instance reboot occurs immediately - // if you enable ApplyImmediately, or will occur during the next maintenance - // window if you disable Apply Immediately. This value is stored as a lowercase - // string. + // 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 maintenance window if Apply Immediately to false. This value is stored + // as a lowercase string. // // Constraints: // @@ -383,8 +386,8 @@ type ModifyDBInstanceInput struct { // Indicates that the DB instance should be associated with the specified option // group. Changing this parameter doesn't result in an outage except in the // following case and the change is applied during the next maintenance window - // unless the ApplyImmediately parameter is enabled for this request. If the - // parameter change results in an option group that enables OEM, this change + // unless the ApplyImmediately parameter is set to true for this request. If + // the parameter change results in an option group that enables OEM, this change // can cause a brief (sub-second) period during which new connections are rejected // but existing connections are not interrupted. // @@ -396,11 +399,6 @@ type ModifyDBInstanceInput struct { // 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. - // - // 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 `type:"string"` // The amount of time, in days, to retain Performance Insights data. Valid values @@ -460,18 +458,20 @@ type ModifyDBInstanceInput struct { // Valid Values: 0 - 15 PromotionTier *int64 `type:"integer"` - // A value that indicates whether the DB instance is publicly accessible. When - // the DB instance is publicly accessible, it is an Internet-facing instance - // with a publicly resolvable DNS name, which resolves to a public IP address. - // When the DB instance is not publicly accessible, it is an internal instance - // with a DNS name that resolves to a private IP address. + // Boolean value that indicates if the DB instance has a publicly resolvable + // DNS name. Set to True to make the DB instance Internet-facing with a publicly + // resolvable DNS name, which resolves to a public IP address. Set to False + // to make the DB instance internal with a DNS name that resolves to a private + // IP address. // // PubliclyAccessible only applies to DB instances in a VPC. The DB instance - // must be part of a public subnet and PubliclyAccessible must be enabled for - // it to be publicly accessible. + // must be part of a public subnet and PubliclyAccessible must be true in order + // for it to be publicly accessible. // // Changes to the PubliclyAccessible parameter are applied immediately regardless // of the value of the ApplyImmediately parameter. + // + // Default: false PubliclyAccessible *bool `type:"boolean"` // Specifies the storage type to be associated with the DB instance. @@ -494,7 +494,7 @@ type ModifyDBInstanceInput struct { // // Valid values: standard | gp2 | io1 // - // Default: io1 if the Iops parameter is specified, otherwise gp2 + // Default: io1 if the Iops parameter is specified, otherwise standard StorageType *string `type:"string"` // The ARN from the key store with which to associate the instance for TDE encryption. @@ -504,7 +504,7 @@ type ModifyDBInstanceInput struct { // device. TdeCredentialPassword *string `type:"string"` - // A value that indicates whether the DB instance class of the DB instance uses + // A value that specifies that the DB instance class of the DB instance uses // its default processor features. UseDefaultProcessorFeatures *bool `type:"boolean"` diff --git a/service/rds/api_op_ModifyEventSubscription.go b/service/rds/api_op_ModifyEventSubscription.go index 7f2022df561..6bb4b7365e2 100644 --- a/service/rds/api_op_ModifyEventSubscription.go +++ b/service/rds/api_op_ModifyEventSubscription.go @@ -13,7 +13,7 @@ import ( type ModifyEventSubscriptionInput struct { _ struct{} `type:"structure"` - // A value that indicates whether to activate the subscription. + // A Boolean value; set to true to activate the subscription. Enabled *bool `type:"boolean"` // A list of event categories for a SourceType that you want to subscribe to. diff --git a/service/rds/api_op_ModifyGlobalCluster.go b/service/rds/api_op_ModifyGlobalCluster.go index 9b84f2a7f59..ebc0fdd8eb8 100644 --- a/service/rds/api_op_ModifyGlobalCluster.go +++ b/service/rds/api_op_ModifyGlobalCluster.go @@ -14,8 +14,7 @@ type ModifyGlobalClusterInput struct { _ struct{} `type:"structure"` // Indicates if the global database cluster has deletion protection enabled. - // The global database cluster can't be deleted when deletion protection is - // enabled. + // The global database cluster can't be deleted when this value is set to true. DeletionProtection *bool `type:"boolean"` // The DB cluster identifier for the global cluster being modified. This parameter diff --git a/service/rds/api_op_ModifyOptionGroup.go b/service/rds/api_op_ModifyOptionGroup.go index 4969e972c32..09e0a319dfa 100644 --- a/service/rds/api_op_ModifyOptionGroup.go +++ b/service/rds/api_op_ModifyOptionGroup.go @@ -14,9 +14,8 @@ import ( type ModifyOptionGroupInput struct { _ struct{} `type:"structure"` - // A value that indicates whether to apply the change immediately or during - // the next maintenance window for each instance associated with the option - // group. + // Indicates whether the changes should be applied immediately, or during the + // next maintenance window for each instance associated with the option group. ApplyImmediately *bool `type:"boolean"` // The name of the option group to be modified. diff --git a/service/rds/api_op_RebootDBInstance.go b/service/rds/api_op_RebootDBInstance.go index cc120c2fa96..4562fc93152 100644 --- a/service/rds/api_op_RebootDBInstance.go +++ b/service/rds/api_op_RebootDBInstance.go @@ -22,11 +22,10 @@ type RebootDBInstanceInput struct { // DBInstanceIdentifier is a required field DBInstanceIdentifier *string `type:"string" required:"true"` - // A value that indicates whether the reboot is conducted through a Multi-AZ - // failover. + // When true, the reboot is conducted through a MultiAZ failover. // - // Constraint: You can't enable force failover if the instance is not configured - // for Multi-AZ. + // Constraint: You can't specify true if the instance is not configured for + // MultiAZ. ForceFailover *bool `type:"boolean"` } diff --git a/service/rds/api_op_ResetDBClusterParameterGroup.go b/service/rds/api_op_ResetDBClusterParameterGroup.go index 59a518e081c..ce6888bc0e7 100644 --- a/service/rds/api_op_ResetDBClusterParameterGroup.go +++ b/service/rds/api_op_ResetDBClusterParameterGroup.go @@ -20,12 +20,12 @@ type ResetDBClusterParameterGroupInput struct { // A list of parameter names in the DB cluster parameter group to reset to the // default values. You can't use this parameter if the ResetAllParameters parameter - // is enabled. + // is set to true. Parameters []Parameter `locationNameList:"Parameter" type:"list"` - // A value that indicates whether to reset all parameters in the DB cluster - // parameter group to their default values. You can't use this parameter if - // there is a list of parameter names specified for the Parameters 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:"boolean"` } diff --git a/service/rds/api_op_ResetDBParameterGroup.go b/service/rds/api_op_ResetDBParameterGroup.go index 8ea0c245fa5..044bfbd2b5e 100644 --- a/service/rds/api_op_ResetDBParameterGroup.go +++ b/service/rds/api_op_ResetDBParameterGroup.go @@ -48,9 +48,10 @@ type ResetDBParameterGroupInput struct { // Valid Values (for Apply method): pending-reboot Parameters []Parameter `locationNameList:"Parameter" type:"list"` - // A value that indicates whether to reset all parameters in the DB parameter - // group to default values. By default, all parameters in the DB parameter group - // are reset to default values. + // Specifies whether (true) or not (false) to reset all parameters in the DB + // parameter group to default values. + // + // Default: true ResetAllParameters *bool `type:"boolean"` } diff --git a/service/rds/api_op_RestoreDBClusterFromS3.go b/service/rds/api_op_RestoreDBClusterFromS3.go index 95ddcff7478..2cb14eb9e19 100644 --- a/service/rds/api_op_RestoreDBClusterFromS3.go +++ b/service/rds/api_op_RestoreDBClusterFromS3.go @@ -42,8 +42,8 @@ type RestoreDBClusterFromS3Input struct { // with the specified CharacterSet. CharacterSetName *string `type:"string"` - // A value that indicates whether to copy all tags from the restored DB cluster - // to snapshots of the restored DB cluster. The default is not to copy them. + // True to copy all tags from the restored DB cluster to snapshots of the restored + // DB cluster, and otherwise false. The default is false. CopyTagsToSnapshot *bool `type:"boolean"` // The name of the DB cluster to create from the source data in the Amazon S3 @@ -80,9 +80,9 @@ type RestoreDBClusterFromS3Input struct { // The database name for the restored DB cluster. DatabaseName *string `type:"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. + // Indicates if the DB cluster should have deletion protection enabled. The + // database can't be deleted when this value is set to true. The default is + // false. DeletionProtection *bool `type:"boolean"` // The list of logs that the restored DB cluster is to export to CloudWatch @@ -91,8 +91,10 @@ type RestoreDBClusterFromS3Input struct { // in the Amazon Aurora User Guide. EnableCloudwatchLogsExports []string `type:"list"` - // A value that indicates whether to enable mapping of AWS Identity and Access - // Management (IAM) accounts to database accounts. By default, mapping is disabled. + // True to enable mapping of AWS Identity and Access Management (IAM) accounts + // to database accounts, and otherwise false. + // + // Default: false EnableIAMDatabaseAuthentication *bool `type:"boolean"` // The name of the database engine to be used for the restored DB cluster. @@ -120,7 +122,7 @@ type RestoreDBClusterFromS3Input struct { // the KMS encryption key used to encrypt the new DB cluster, then you can use // the KMS key alias instead of the ARN for the KM encryption key. // - // If the StorageEncrypted parameter is enabled, and you do not specify a value + // If the StorageEncrypted parameter is true, and you do not specify a value // for the KmsKeyId parameter, then Amazon RDS will use 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. @@ -231,7 +233,7 @@ type RestoreDBClusterFromS3Input struct { // SourceEngineVersion is a required field SourceEngineVersion *string `type:"string" required:"true"` - // A value that indicates whether the restored DB cluster is encrypted. + // Specifies whether the restored DB cluster is encrypted. StorageEncrypted *bool `type:"boolean"` // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) diff --git a/service/rds/api_op_RestoreDBClusterFromSnapshot.go b/service/rds/api_op_RestoreDBClusterFromSnapshot.go index e54440fe329..a69c0cbbfc2 100644 --- a/service/rds/api_op_RestoreDBClusterFromSnapshot.go +++ b/service/rds/api_op_RestoreDBClusterFromSnapshot.go @@ -28,8 +28,8 @@ type RestoreDBClusterFromSnapshotInput struct { // hours). BacktrackWindow *int64 `type:"long"` - // A value that indicates whether to copy all tags from the restored DB cluster - // to snapshots of the restored DB cluster. The default is not to copy them. + // True to copy all tags from the restored DB cluster to snapshots of the restored + // DB cluster, and otherwise false. The default is false. CopyTagsToSnapshot *bool `type:"boolean"` // The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. @@ -74,9 +74,9 @@ type RestoreDBClusterFromSnapshotInput struct { // The database name for the restored DB cluster. DatabaseName *string `type:"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. + // Indicates if the DB cluster should have deletion protection enabled. The + // database can't be deleted when this value is set to true. The default is + // false. DeletionProtection *bool `type:"boolean"` // The list of logs that the restored DB cluster is to export to Amazon CloudWatch @@ -85,8 +85,10 @@ type RestoreDBClusterFromSnapshotInput struct { // in the Amazon Aurora User Guide. EnableCloudwatchLogsExports []string `type:"list"` - // A value that indicates whether to enable mapping of AWS Identity and Access - // Management (IAM) accounts to database accounts. By default, mapping is disabled. + // True to enable mapping of AWS Identity and Access Management (IAM) accounts + // to database accounts, and otherwise false. + // + // Default: false EnableIAMDatabaseAuthentication *bool `type:"boolean"` // The database engine to use for the new DB cluster. diff --git a/service/rds/api_op_RestoreDBClusterToPointInTime.go b/service/rds/api_op_RestoreDBClusterToPointInTime.go index 69e4be94226..012c85d530b 100644 --- a/service/rds/api_op_RestoreDBClusterToPointInTime.go +++ b/service/rds/api_op_RestoreDBClusterToPointInTime.go @@ -25,8 +25,8 @@ type RestoreDBClusterToPointInTimeInput struct { // hours). BacktrackWindow *int64 `type:"long"` - // A value that indicates whether to copy all tags from the restored DB cluster - // to snapshots of the restored DB cluster. The default is not to copy them. + // True to copy all tags from the restored DB cluster to snapshots of the restored + // DB cluster, and otherwise false. The default is false. CopyTagsToSnapshot *bool `type:"boolean"` // The name of the new DB cluster to be created. @@ -65,9 +65,9 @@ type RestoreDBClusterToPointInTimeInput struct { // Example: mySubnetgroup DBSubnetGroupName *string `type:"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. + // Indicates if the DB cluster should have deletion protection enabled. The + // database can't be deleted when this value is set to true. The default is + // false. DeletionProtection *bool `type:"boolean"` // The list of logs that the restored DB cluster is to export to CloudWatch @@ -76,8 +76,10 @@ type RestoreDBClusterToPointInTimeInput struct { // in the Amazon Aurora User Guide. EnableCloudwatchLogsExports []string `type:"list"` - // A value that indicates whether to enable mapping of AWS Identity and Access - // Management (IAM) accounts to database accounts. By default, mapping is disabled. + // True to enable mapping of AWS Identity and Access Management (IAM) accounts + // to database accounts, and otherwise false. + // + // Default: false EnableIAMDatabaseAuthentication *bool `type:"boolean"` // The AWS KMS key identifier to use when restoring an encrypted DB cluster @@ -126,9 +128,9 @@ type RestoreDBClusterToPointInTimeInput struct { // // * Must be specified if UseLatestRestorableTime parameter is not provided // - // * Can't be specified if the UseLatestRestorableTime parameter is enabled + // * Can't be specified if UseLatestRestorableTime parameter is true // - // * Can't be specified if the RestoreType parameter is copy-on-write + // * Can't be specified if RestoreType parameter is copy-on-write // // Example: 2015-03-07T23:45:00Z RestoreToTime *time.Time `type:"timestamp" timestampFormat:"iso8601"` @@ -162,9 +164,10 @@ type RestoreDBClusterToPointInTimeInput struct { // in the Amazon RDS User Guide. Tags []Tag `locationNameList:"Tag" type:"list"` - // A value that indicates whether to restore the DB cluster to the latest restorable - // backup time. By default, the DB cluster is not restored to the latest restorable - // backup time. + // A value that is set to true to restore the DB cluster to the latest restorable + // backup time, and false otherwise. + // + // Default: false // // Constraints: Can't be specified if RestoreToTime parameter is provided. UseLatestRestorableTime *bool `type:"boolean"` diff --git a/service/rds/api_op_RestoreDBInstanceFromDBSnapshot.go b/service/rds/api_op_RestoreDBInstanceFromDBSnapshot.go index 3f9d9837e18..ad4c54cae74 100644 --- a/service/rds/api_op_RestoreDBInstanceFromDBSnapshot.go +++ b/service/rds/api_op_RestoreDBInstanceFromDBSnapshot.go @@ -13,22 +13,22 @@ import ( type RestoreDBInstanceFromDBSnapshotInput struct { _ struct{} `type:"structure"` - // A value that indicates whether minor version upgrades are applied automatically - // to the DB instance during the maintenance window. + // Indicates that minor version upgrades are applied automatically to the DB + // instance during the maintenance window. AutoMinorVersionUpgrade *bool `type:"boolean"` // 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. + // Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ + // parameter is set to true. // // Example: us-east-1a AvailabilityZone *string `type:"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. + // True to copy all tags from the restored DB instance to snapshots of the restored + // DB instance, and otherwise false. The default is false. CopyTagsToSnapshot *bool `type:"boolean"` // The compute and memory capacity of the Amazon RDS DB instance, for example, @@ -95,10 +95,9 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // Example: mySubnetgroup DBSubnetGroupName *string `type:"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. For more information, see Deleting a DB - // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + // Indicates if the DB instance should have deletion protection enabled. The + // database can't be deleted when this value is set to true. The default is + // false. For more information, see Deleting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). DeletionProtection *bool `type:"boolean"` // Specify the Active Directory Domain to restore the instance in. @@ -114,14 +113,16 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // in the Amazon Aurora User Guide. EnableCloudwatchLogsExports []string `type:"list"` - // A value that indicates whether to enable mapping of AWS Identity and Access - // Management (IAM) accounts to database accounts. By default, mapping is disabled. + // 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 // // * For MySQL 5.6, minor version 5.6.34 or higher // // * For MySQL 5.7, minor version 5.7.16 or higher + // + // Default: false EnableIAMDatabaseAuthentication *bool `type:"boolean"` // The database engine to use for the new instance. @@ -178,10 +179,10 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // Valid values: license-included | bring-your-own-license | general-public-license LicenseModel *string `type:"string"` - // A value that indicates whether the DB instance is a Multi-AZ deployment. + // Specifies if 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. + // Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ + // parameter is set to true. MultiAZ *bool `type:"boolean"` // The name of the option group to be used for the restored DB instance. @@ -202,12 +203,11 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // class of the DB instance. ProcessorFeatures []ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"` - // A value that indicates whether the DB instance is publicly accessible. When - // the DB instance is publicly accessible, it is an Internet-facing instance - // with a publicly resolvable DNS name, which resolves to a public IP address. - // When the DB instance is not publicly accessible, it is an internal instance - // with a DNS name that resolves to a private IP address. For more information, - // see CreateDBInstance. + // 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. For more + // information, see CreateDBInstance. PubliclyAccessible *bool `type:"boolean"` // Specifies the storage type to be associated with the DB instance. @@ -216,7 +216,7 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // // If you specify io1, you must also include a value for the Iops parameter. // - // Default: io1 if the Iops parameter is specified, otherwise gp2 + // Default: io1 if the Iops parameter is specified, otherwise standard StorageType *string `type:"string"` // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) @@ -230,7 +230,7 @@ type RestoreDBInstanceFromDBSnapshotInput struct { // device. TdeCredentialPassword *string `type:"string"` - // A value that indicates whether the DB instance class of the DB instance uses + // A value that specifies that the DB instance class of the DB instance uses // its default processor features. UseDefaultProcessorFeatures *bool `type:"boolean"` diff --git a/service/rds/api_op_RestoreDBInstanceFromS3.go b/service/rds/api_op_RestoreDBInstanceFromS3.go index cfbe86db53a..9a670c940a9 100644 --- a/service/rds/api_op_RestoreDBInstanceFromS3.go +++ b/service/rds/api_op_RestoreDBInstanceFromS3.go @@ -21,9 +21,10 @@ type RestoreDBInstanceFromS3Input struct { // growth. AllocatedStorage *int64 `type:"integer"` - // 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. + // True to indicate that minor engine upgrades are applied automatically to + // the DB instance during the maintenance window, and otherwise false. + // + // Default: true AutoMinorVersionUpgrade *bool `type:"boolean"` // The Availability Zone that the DB instance is created in. For information @@ -36,8 +37,8 @@ type RestoreDBInstanceFromS3Input struct { // // Example: us-east-1d // - // Constraint: The AvailabilityZone parameter can't be specified if the DB instance - // is a Multi-AZ deployment. The specified Availability Zone must be in the + // 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 `type:"string"` @@ -46,8 +47,10 @@ type RestoreDBInstanceFromS3Input struct { // CreateDBInstance. BackupRetentionPeriod *int64 `type:"integer"` - // 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. + // True to copy all tags from the restored DB instance to snapshots of the restored + // DB instance, and otherwise false. + // + // Default: false. CopyTagsToSnapshot *bool `type:"boolean"` // The compute and memory capacity of the DB instance, for example, db.m4.large. @@ -94,10 +97,9 @@ type RestoreDBInstanceFromS3Input struct { // A DB subnet group to associate with this DB instance. DBSubnetGroupName *string `type:"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. For more information, see Deleting a DB - // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + // Indicates if the DB instance should have deletion protection enabled. The + // database can't be deleted when this value is set to true. The default is + // false. For more information, see Deleting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). DeletionProtection *bool `type:"boolean"` // The list of logs that the restored DB instance is to export to CloudWatch @@ -106,12 +108,13 @@ type RestoreDBInstanceFromS3Input struct { // in the Amazon RDS User Guide. EnableCloudwatchLogsExports []string `type:"list"` - // A value that indicates whether to enable mapping of AWS Identity and Access - // Management (IAM) accounts to database accounts. By default, mapping is disabled. + // True to enable mapping of AWS Identity and Access Management (IAM) accounts + // to database accounts, and otherwise false. + // + // Default: false EnableIAMDatabaseAuthentication *bool `type:"boolean"` - // A value that indicates whether to enable Performance Insights for the DB - // instance. + // True to enable Performance Insights for the DB instance, and otherwise false. // // 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. @@ -142,7 +145,7 @@ type RestoreDBInstanceFromS3Input struct { // the KMS encryption key used to encrypt the new DB instance, then you can // use the KMS key alias instead of the ARN for the KM encryption key. // - // If the StorageEncrypted parameter is enabled, and you do not specify a value + // If the StorageEncrypted parameter is true, and you do not specify a value // for the KmsKeyId parameter, then Amazon RDS will use 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. @@ -190,9 +193,8 @@ type RestoreDBInstanceFromS3Input struct { // a MonitoringRoleArn value. MonitoringRoleArn *string `type:"string"` - // 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. + // Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ is + // set to true, you can't set the AvailabilityZone parameter. MultiAZ *bool `type:"boolean"` // The name of the option group to associate with this DB instance. If this @@ -203,11 +205,6 @@ type RestoreDBInstanceFromS3Input struct { // 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 `type:"string"` // The amount of time, in days, to retain Performance Insights data. Valid values @@ -260,12 +257,11 @@ type RestoreDBInstanceFromS3Input struct { // class of the DB instance. ProcessorFeatures []ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"` - // A value that indicates whether the DB instance is publicly accessible. When - // the DB instance is publicly accessible, it is an Internet-facing instance - // with a publicly resolvable DNS name, which resolves to a public IP address. - // When the DB instance is not publicly accessible, it is an internal instance - // with a DNS name that resolves to a private IP address. For more information, - // see CreateDBInstance. + // 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. For more + // information, see CreateDBInstance. PubliclyAccessible *bool `type:"boolean"` // The name of your Amazon S3 bucket that contains your database backup file. @@ -296,7 +292,7 @@ type RestoreDBInstanceFromS3Input struct { // SourceEngineVersion is a required field SourceEngineVersion *string `type:"string" required:"true"` - // A value that indicates whether the new DB instance is encrypted or not. + // Specifies whether the new DB instance is encrypted or not. StorageEncrypted *bool `type:"boolean"` // Specifies the storage type to be associated with the DB instance. @@ -305,7 +301,7 @@ type RestoreDBInstanceFromS3Input struct { // // If you specify io1, you must also include a value for the Iops parameter. // - // Default: io1 if the Iops parameter is specified; otherwise gp2 + // Default: io1 if the Iops parameter is specified; otherwise standard StorageType *string `type:"string"` // A list of tags to associate with this DB instance. For more information, @@ -313,7 +309,7 @@ type RestoreDBInstanceFromS3Input struct { // in the Amazon RDS User Guide. Tags []Tag `locationNameList:"Tag" type:"list"` - // A value that indicates whether the DB instance class of the DB instance uses + // A value that specifies that the DB instance class of the DB instance uses // its default processor features. UseDefaultProcessorFeatures *bool `type:"boolean"` diff --git a/service/rds/api_op_RestoreDBInstanceToPointInTime.go b/service/rds/api_op_RestoreDBInstanceToPointInTime.go index 93e5b3c45d8..ee3a16b439a 100644 --- a/service/rds/api_op_RestoreDBInstanceToPointInTime.go +++ b/service/rds/api_op_RestoreDBInstanceToPointInTime.go @@ -14,22 +14,22 @@ import ( type RestoreDBInstanceToPointInTimeInput struct { _ struct{} `type:"structure"` - // A value that indicates whether minor version upgrades are applied automatically - // to the DB instance during the maintenance window. + // Indicates that minor version upgrades are applied automatically to the DB + // instance during the maintenance window. AutoMinorVersionUpgrade *bool `type:"boolean"` // 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. + // Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ + // parameter is set to true. // // Example: us-east-1a AvailabilityZone *string `type:"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. + // True to copy all tags from the restored DB instance to snapshots of the restored + // DB instance, and otherwise false. The default is false. CopyTagsToSnapshot *bool `type:"boolean"` // The compute and memory capacity of the Amazon RDS DB instance, for example, @@ -68,10 +68,9 @@ type RestoreDBInstanceToPointInTimeInput struct { // Example: mySubnetgroup DBSubnetGroupName *string `type:"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. For more information, see Deleting a DB - // Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). + // Indicates if the DB instance should have deletion protection enabled. The + // database can't be deleted when this value is set to true. The default is + // false. For more information, see Deleting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). DeletionProtection *bool `type:"boolean"` // Specify the Active Directory Domain to restore the instance in. @@ -87,14 +86,16 @@ type RestoreDBInstanceToPointInTimeInput struct { // in the Amazon RDS User Guide. EnableCloudwatchLogsExports []string `type:"list"` - // A value that indicates whether to enable mapping of AWS Identity and Access - // Management (IAM) accounts to database accounts. By default, mapping is disabled. + // 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 // // * For MySQL 5.6, minor version 5.6.34 or higher // // * For MySQL 5.7, minor version 5.7.16 or higher + // + // Default: false EnableIAMDatabaseAuthentication *bool `type:"boolean"` // The database engine to use for the new instance. @@ -145,10 +146,10 @@ type RestoreDBInstanceToPointInTimeInput struct { // Valid values: license-included | bring-your-own-license | general-public-license LicenseModel *string `type:"string"` - // A value that indicates whether the DB instance is a Multi-AZ deployment. + // Specifies if 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. + // Constraint: You can't specify the AvailabilityZone parameter if the MultiAZ + // parameter is set to true. MultiAZ *bool `type:"boolean"` // The name of the option group to be used for the restored DB instance. @@ -169,12 +170,11 @@ type RestoreDBInstanceToPointInTimeInput struct { // class of the DB instance. ProcessorFeatures []ProcessorFeature `locationNameList:"ProcessorFeature" type:"list"` - // A value that indicates whether the DB instance is publicly accessible. When - // the DB instance is publicly accessible, it is an Internet-facing instance - // with a publicly resolvable DNS name, which resolves to a public IP address. - // When the DB instance is not publicly accessible, it is an internal instance - // with a DNS name that resolves to a private IP address. For more information, - // see CreateDBInstance. + // 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. For more + // information, see CreateDBInstance. PubliclyAccessible *bool `type:"boolean"` // The date and time to restore from. @@ -185,7 +185,7 @@ type RestoreDBInstanceToPointInTimeInput struct { // // * Must be before the latest restorable time for the DB instance // - // * Can't be specified if the UseLatestRestorableTime parameter is enabled + // * Can't be specified if UseLatestRestorableTime parameter is true // // Example: 2009-09-07T23:45:00Z RestoreTime *time.Time `type:"timestamp" timestampFormat:"iso8601"` @@ -206,7 +206,7 @@ type RestoreDBInstanceToPointInTimeInput struct { // // If you specify io1, you must also include a value for the Iops parameter. // - // Default: io1 if the Iops parameter is specified, otherwise gp2 + // Default: io1 if the Iops parameter is specified, otherwise standard StorageType *string `type:"string"` // A list of tags. For more information, see Tagging Amazon RDS Resources (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) @@ -233,15 +233,16 @@ type RestoreDBInstanceToPointInTimeInput struct { // device. TdeCredentialPassword *string `type:"string"` - // A value that indicates whether the DB instance class of the DB instance uses + // A value that specifies that the DB instance class of the DB instance uses // its default processor features. UseDefaultProcessorFeatures *bool `type:"boolean"` - // A value that indicates whether the DB instance is restored from the latest - // backup time. By default, the DB instance is not restored from the latest - // backup time. + // Specifies whether (true) or not (false) the DB instance is restored from + // the latest backup time. + // + // Default: false // - // Constraints: Can't be specified if the RestoreTime parameter is provided. + // Constraints: Can't be specified if RestoreTime parameter is provided. UseLatestRestorableTime *bool `type:"boolean"` // A list of EC2 VPC security groups to associate with this DB instance. diff --git a/service/rds/api_types.go b/service/rds/api_types.go index a917eeaa29f..a882ba00a86 100644 --- a/service/rds/api_types.go +++ b/service/rds/api_types.go @@ -12,81 +12,8 @@ import ( var _ aws.Config var _ = awsutil.Prettify -// Describes a quota for an AWS account. -// -// The following are account quotas: -// -// * AllocatedStorage - The total allocated storage per account, in GiB. -// The used value is the total allocated storage in the account, in GiB. -// -// * AuthorizationsPerDBSecurityGroup - The number of ingress rules per DB -// security group. The used value is the highest number of ingress rules -// in a DB security group in the account. Other DB security groups in the -// account might have a lower number of ingress rules. -// -// * CustomEndpointsPerDBCluster - The number of custom endpoints per DB -// cluster. The used value is the highest number of custom endpoints in a -// DB clusters in the account. Other DB clusters in the account might have -// a lower number of custom endpoints. -// -// * DBClusterParameterGroups - The number of DB cluster parameter groups -// per account, excluding default parameter groups. The used value is the -// count of nondefault DB cluster parameter groups in the account. -// -// * DBClusterRoles - The number of associated AWS Identity and Access Management -// (IAM) roles per DB cluster. The used value is the highest number of associated -// IAM roles for a DB cluster in the account. Other DB clusters in the account -// might have a lower number of associated IAM roles. -// -// * DBClusters - The number of DB clusters per account. The used value is -// the count of DB clusters in the account. -// -// * DBInstanceRoles - The number of associated IAM roles per DB instance. -// The used value is the highest number of associated IAM roles for a DB -// instance in the account. Other DB instances in the account might have -// a lower number of associated IAM roles. -// -// * DBInstances - The number of DB instances per account. The used value -// is the count of the DB instances in the account. -// -// * DBParameterGroups - The number of DB parameter groups per account, excluding -// default parameter groups. The used value is the count of nondefault DB -// parameter groups in the account. -// -// * DBSecurityGroups - The number of DB security groups (not VPC security -// groups) per account, excluding the default security group. The used value -// is the count of nondefault DB security groups in the account. -// -// * DBSubnetGroups - The number of DB subnet groups per account. The used -// value is the count of the DB subnet groups in the account. -// -// * EventSubscriptions - The number of event subscriptions per account. -// The used value is the count of the event subscriptions in the account. -// -// * ManualSnapshots - The number of manual DB snapshots per account. The -// used value is the count of the manual DB snapshots in the account. -// -// * OptionGroups - The number of DB option groups per account, excluding -// default option groups. The used value is the count of nondefault DB option -// groups in the account. -// -// * ReadReplicasPerMaster - The number of Read Replicas per DB instance. -// The used value is the highest number of Read Replicas for a DB instance -// in the account. Other DB instances in the account might have a lower number -// of Read Replicas. -// -// * ReservedDBInstances - The number of reserved DB instances per account. -// The used value is the count of the active reserved DB instances in the -// account. -// -// * SubnetsPerDBSubnetGroup - The number of subnets per DB subnet group. -// The used value is highest number of subnets for a DB subnet group in the -// account. Other DB subnet groups in the account might have a lower number -// of subnets. -// -// For more information, see Limits (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html) -// in the Amazon RDS User Guide and Limits (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html) -// in the Amazon Aurora User Guide. +// Describes a quota for an AWS account, for example, the number of DB instances +// allowed. // Please also see https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/AccountQuota type AccountQuota struct { _ struct{} `type:"structure"` @@ -309,7 +236,7 @@ type DBCluster struct { DbClusterResourceId *string `type:"string"` // Indicates if the DB cluster has deletion protection enabled. The database - // can't be deleted when deletion protection is enabled. + // can't be deleted when this value is set to true. DeletionProtection *bool `type:"boolean"` // The earliest time to which a DB cluster can be backtracked. @@ -347,8 +274,8 @@ type DBCluster struct { // HTTP endpoint functionality is in beta for Aurora Serverless and is subject // to change. // - // A value that indicates whether the HTTP endpoint for an Aurora Serverless - // DB cluster is enabled. + // Value that is true if the HTTP endpoint for an Aurora Serverless DB cluster + // is enabled and false otherwise. // // When enabled, the HTTP endpoint provides a connectionless web service API // for running SQL queries on the Aurora Serverless DB cluster. You can also @@ -359,11 +286,11 @@ type DBCluster struct { // in the Amazon Aurora User Guide. HttpEndpointEnabled *bool `type:"boolean"` - // A value that indicates whether the mapping of AWS Identity and Access Management - // (IAM) accounts to database accounts is enabled. + // True if mapping of AWS Identity and Access Management (IAM) accounts to database + // accounts is enabled, and otherwise false. IAMDatabaseAuthenticationEnabled *bool `type:"boolean"` - // If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted + // If StorageEncrypted is true, the AWS KMS key identifier for the encrypted // DB cluster. KmsKeyId *string `type:"string"` @@ -549,8 +476,8 @@ type DBClusterMember struct { // Specifies the instance identifier for this member of the DB cluster. DBInstanceIdentifier *string `type:"string"` - // A value that indicates whehter the cluster member is the primary instance - // for the DB cluster. + // Value that is true if the cluster member is the primary instance for the + // DB cluster and false otherwise. IsClusterWriter *bool `type:"boolean"` // A value that specifies the order in which an Aurora Replica is promoted to @@ -808,6 +735,9 @@ type DBEngineVersion struct { // Logs. ExportableLogTypes []string `type:"list"` + // The status of the DB engine version, either available or deprecated. + Status *string `type:"string"` + // A list of the character sets supported by this engine for the CharacterSetName // parameter of the CreateDBInstance action. SupportedCharacterSets []CharacterSet `locationNameList:"CharacterSet" type:"list"` @@ -937,8 +867,8 @@ type DBInstance struct { DbiResourceId *string `type:"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). + // can't be deleted when this value is set to true. For more information, see + // Deleting a DB Instance (https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). DeletionProtection *bool `type:"boolean"` // The Active Directory Domain membership records associated with the DB instance. @@ -2792,7 +2722,7 @@ func (s RestoreWindow) String() string { type ScalingConfiguration struct { _ struct{} `type:"structure"` - // A value that indicates whether to allow or disallow automatic pause for an + // A value that specifies 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). // @@ -2803,14 +2733,14 @@ type ScalingConfiguration struct { // The maximum capacity for an Aurora DB cluster in serverless DB engine mode. // - // Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. + // Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256. // // The maximum capacity must be greater than or equal to the minimum capacity. MaxCapacity *int64 `type:"integer"` // The minimum capacity for an Aurora DB cluster in serverless DB engine mode. // - // Valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256. + // Valid capacity values are 2, 4, 8, 16, 32, 64, 128, and 256. // // The minimum capacity must be less than or equal to the maximum capacity. MinCapacity *int64 `type:"integer"` @@ -2821,14 +2751,11 @@ type ScalingConfiguration struct { // The action to take when the timeout is reached, either ForceApplyCapacityChange // or RollbackCapacityChange. // - // ForceApplyCapacityChange sets the capacity to the specified value as soon - // as possible. - // - // RollbackCapacityChange, the default, ignores the capacity change if a scaling - // point is not found in the timeout period. + // ForceApplyCapacityChange, the default, sets the capacity to the specified + // value as soon as possible. // - // If you specify ForceApplyCapacityChange, connections that prevent Aurora - // Serverless from finding a scaling point might be dropped. + // RollbackCapacityChange ignores the capacity change if a scaling point is + // not found in the timeout period. // // For more information, see Autoscaling for Aurora Serverless (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. diff --git a/service/robomaker/api_enums.go b/service/robomaker/api_enums.go index 9a4145f687a..204dff8d684 100644 --- a/service/robomaker/api_enums.go +++ b/service/robomaker/api_enums.go @@ -60,6 +60,7 @@ const ( DeploymentStatusInProgress DeploymentStatus = "InProgress" DeploymentStatusFailed DeploymentStatus = "Failed" DeploymentStatusSucceeded DeploymentStatus = "Succeeded" + DeploymentStatusCanceled DeploymentStatus = "Canceled" ) func (enum DeploymentStatus) MarshalValue() (string, error) { diff --git a/service/robomaker/api_op_CancelDeploymentJob.go b/service/robomaker/api_op_CancelDeploymentJob.go new file mode 100644 index 00000000000..5906e1658b6 --- /dev/null +++ b/service/robomaker/api_op_CancelDeploymentJob.go @@ -0,0 +1,139 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package robomaker + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" + "github.com/aws/aws-sdk-go-v2/private/protocol" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CancelDeploymentJobRequest +type CancelDeploymentJobInput struct { + _ struct{} `type:"structure"` + + // The deployment job ARN to cancel. + // + // Job is a required field + Job *string `locationName:"job" min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s CancelDeploymentJobInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CancelDeploymentJobInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "CancelDeploymentJobInput"} + + if s.Job == nil { + invalidParams.Add(aws.NewErrParamRequired("Job")) + } + if s.Job != nil && len(*s.Job) < 1 { + invalidParams.Add(aws.NewErrParamMinLen("Job", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s CancelDeploymentJobInput) MarshalFields(e protocol.FieldEncoder) error { + e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/x-amz-json-1.1"), protocol.Metadata{}) + + if s.Job != nil { + v := *s.Job + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "job", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CancelDeploymentJobResponse +type CancelDeploymentJobOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation +func (s CancelDeploymentJobOutput) String() string { + return awsutil.Prettify(s) +} + +// MarshalFields encodes the AWS API shape using the passed in protocol encoder. +func (s CancelDeploymentJobOutput) MarshalFields(e protocol.FieldEncoder) error { + return nil +} + +const opCancelDeploymentJob = "CancelDeploymentJob" + +// CancelDeploymentJobRequest returns a request value for making API operation for +// AWS RoboMaker. +// +// Cancels the specified deployment job. +// +// // Example sending a request using CancelDeploymentJobRequest. +// req := client.CancelDeploymentJobRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CancelDeploymentJob +func (c *Client) CancelDeploymentJobRequest(input *CancelDeploymentJobInput) CancelDeploymentJobRequest { + op := &aws.Operation{ + Name: opCancelDeploymentJob, + HTTPMethod: "POST", + HTTPPath: "/cancelDeploymentJob", + } + + if input == nil { + input = &CancelDeploymentJobInput{} + } + + req := c.newRequest(op, input, &CancelDeploymentJobOutput{}) + return CancelDeploymentJobRequest{Request: req, Input: input, Copy: c.CancelDeploymentJobRequest} +} + +// CancelDeploymentJobRequest is the request type for the +// CancelDeploymentJob API operation. +type CancelDeploymentJobRequest struct { + *aws.Request + Input *CancelDeploymentJobInput + Copy func(*CancelDeploymentJobInput) CancelDeploymentJobRequest +} + +// Send marshals and sends the CancelDeploymentJob API request. +func (r CancelDeploymentJobRequest) Send(ctx context.Context) (*CancelDeploymentJobResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &CancelDeploymentJobResponse{ + CancelDeploymentJobOutput: r.Request.Data.(*CancelDeploymentJobOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// CancelDeploymentJobResponse is the response type for the +// CancelDeploymentJob API operation. +type CancelDeploymentJobResponse struct { + *CancelDeploymentJobOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// CancelDeploymentJob request. +func (r *CancelDeploymentJobResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/robomaker/api_op_CreateSimulationJob.go b/service/robomaker/api_op_CreateSimulationJob.go index 13a91b0d49d..8f7b58480b8 100644 --- a/service/robomaker/api_op_CreateSimulationJob.go +++ b/service/robomaker/api_op_CreateSimulationJob.go @@ -288,6 +288,10 @@ type CreateSimulationJobOutput struct { // specified in its associated policies on your behalf. IamRole *string `locationName:"iamRole" min:"1" type:"string"` + // The time, in milliseconds since the epoch, when the simulation job was last + // started. + LastStartedAt *time.Time `locationName:"lastStartedAt" type:"timestamp" timestampFormat:"unix"` + // The time, in milliseconds since the epoch, when the simulation job was last // updated. LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp" timestampFormat:"unix"` @@ -354,6 +358,12 @@ func (s CreateSimulationJobOutput) MarshalFields(e protocol.FieldEncoder) error metadata := protocol.Metadata{} e.SetValue(protocol.BodyTarget, "iamRole", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) } + if s.LastStartedAt != nil { + v := *s.LastStartedAt + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "lastStartedAt", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } if s.LastUpdatedAt != nil { v := *s.LastUpdatedAt diff --git a/service/robomaker/api_op_DescribeSimulationJob.go b/service/robomaker/api_op_DescribeSimulationJob.go index 08d4437e356..4fb78893129 100644 --- a/service/robomaker/api_op_DescribeSimulationJob.go +++ b/service/robomaker/api_op_DescribeSimulationJob.go @@ -139,6 +139,10 @@ type DescribeSimulationJobOutput struct { // are specified in its associated policies on your behalf. IamRole *string `locationName:"iamRole" min:"1" type:"string"` + // The time, in milliseconds since the epoch, when the simulation job was last + // started. + LastStartedAt *time.Time `locationName:"lastStartedAt" type:"timestamp" timestampFormat:"unix"` + // The time, in milliseconds since the epoch, when the simulation job was last // updated. LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp" timestampFormat:"unix"` @@ -215,6 +219,12 @@ func (s DescribeSimulationJobOutput) MarshalFields(e protocol.FieldEncoder) erro metadata := protocol.Metadata{} e.SetValue(protocol.BodyTarget, "iamRole", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) } + if s.LastStartedAt != nil { + v := *s.LastStartedAt + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "lastStartedAt", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } if s.LastUpdatedAt != nil { v := *s.LastUpdatedAt diff --git a/service/robomaker/api_types.go b/service/robomaker/api_types.go index a8bc390175a..c9b9af3c5db 100644 --- a/service/robomaker/api_types.go +++ b/service/robomaker/api_types.go @@ -607,11 +607,11 @@ type ProgressDetail struct { // // Validating the deployment. // - // Downloading/Extracting + // DownloadingExtracting // // Downloading and extracting the bundle on the robot. // - // Executing pre-launch script(s) + // ExecutingPreLaunch // // Executing pre-launch script(s) if provided. // @@ -619,7 +619,7 @@ type ProgressDetail struct { // // Launching the robot application. // - // Executing post-launch script(s) + // ExecutingPostLaunch // // Executing post-launch script(s) if provided. // @@ -897,6 +897,9 @@ type RobotApplicationSummary struct { // The name of the robot application. Name *string `locationName:"name" min:"1" type:"string"` + // Information about a robot software suite. + RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` + // The version of the robot application. Version *string `locationName:"version" min:"1" type:"string"` } @@ -926,6 +929,12 @@ func (s RobotApplicationSummary) MarshalFields(e protocol.FieldEncoder) error { metadata := protocol.Metadata{} e.SetValue(protocol.BodyTarget, "name", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) } + if s.RobotSoftwareSuite != nil { + v := s.RobotSoftwareSuite + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "robotSoftwareSuite", v, metadata) + } if s.Version != nil { v := *s.Version @@ -1139,6 +1148,12 @@ type SimulationApplicationSummary struct { // The name of the simulation application. Name *string `locationName:"name" min:"1" type:"string"` + // Information about a robot software suite. + RobotSoftwareSuite *RobotSoftwareSuite `locationName:"robotSoftwareSuite" type:"structure"` + + // Information about a simulation software suite. + SimulationSoftwareSuite *SimulationSoftwareSuite `locationName:"simulationSoftwareSuite" type:"structure"` + // The version of the simulation application. Version *string `locationName:"version" min:"1" type:"string"` } @@ -1168,6 +1183,18 @@ func (s SimulationApplicationSummary) MarshalFields(e protocol.FieldEncoder) err metadata := protocol.Metadata{} e.SetValue(protocol.BodyTarget, "name", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) } + if s.RobotSoftwareSuite != nil { + v := s.RobotSoftwareSuite + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "robotSoftwareSuite", v, metadata) + } + if s.SimulationSoftwareSuite != nil { + v := s.SimulationSoftwareSuite + + metadata := protocol.Metadata{} + e.SetFields(protocol.BodyTarget, "simulationSoftwareSuite", v, metadata) + } if s.Version != nil { v := *s.Version @@ -1207,10 +1234,13 @@ type SimulationJob struct { // 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. See how to specify AWS security credentials - // for your application (https://docs.aws.amazon.com/toolkit-for-visual-studio/latest/user-guide/deployment-ecs-specify-credentials). + // are passed in to your simulation job. IamRole *string `locationName:"iamRole" min:"1" type:"string"` + // The time, in milliseconds since the epoch, when the simulation job was last + // started. + LastStartedAt *time.Time `locationName:"lastStartedAt" type:"timestamp" timestampFormat:"unix"` + // The time, in milliseconds since the epoch, when the simulation job was last // updated. LastUpdatedAt *time.Time `locationName:"lastUpdatedAt" type:"timestamp" timestampFormat:"unix"` @@ -1288,6 +1318,12 @@ func (s SimulationJob) MarshalFields(e protocol.FieldEncoder) error { metadata := protocol.Metadata{} e.SetValue(protocol.BodyTarget, "iamRole", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata) } + if s.LastStartedAt != nil { + v := *s.LastStartedAt + + metadata := protocol.Metadata{} + e.SetValue(protocol.BodyTarget, "lastStartedAt", protocol.TimeValue{V: v, Format: protocol.UnixTimeFormat}, metadata) + } if s.LastUpdatedAt != nil { v := *s.LastUpdatedAt diff --git a/service/robomaker/robomakeriface/interface.go b/service/robomaker/robomakeriface/interface.go index 723712254bb..d2420669af3 100644 --- a/service/robomaker/robomakeriface/interface.go +++ b/service/robomaker/robomakeriface/interface.go @@ -63,6 +63,8 @@ import ( type ClientAPI interface { BatchDescribeSimulationJobRequest(*robomaker.BatchDescribeSimulationJobInput) robomaker.BatchDescribeSimulationJobRequest + CancelDeploymentJobRequest(*robomaker.CancelDeploymentJobInput) robomaker.CancelDeploymentJobRequest + CancelSimulationJobRequest(*robomaker.CancelSimulationJobInput) robomaker.CancelSimulationJobRequest CreateDeploymentJobRequest(*robomaker.CreateDeploymentJobInput) robomaker.CreateDeploymentJobRequest diff --git a/service/storagegateway/api_op_AssignTapePool.go b/service/storagegateway/api_op_AssignTapePool.go new file mode 100644 index 00000000000..1acf0893c35 --- /dev/null +++ b/service/storagegateway/api_op_AssignTapePool.go @@ -0,0 +1,149 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package storagegateway + +import ( + "context" + + "github.com/aws/aws-sdk-go-v2/aws" + "github.com/aws/aws-sdk-go-v2/internal/awsutil" +) + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AssignTapePoolInput +type AssignTapePoolInput struct { + _ struct{} `type:"structure"` + + // 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 (Glacier or Deep Archive) that + // corresponds to the pool. + // + // Valid values: "GLACIER", "DEEP_ARCHIVE" + // + // PoolId is a required field + PoolId *string `min:"1" type:"string" required:"true"` + + // The unique Amazon Resource Name (ARN) of the virtual tape that you want to + // add to the tape pool. + // + // TapeARN is a required field + TapeARN *string `min:"50" type:"string" required:"true"` +} + +// String returns the string representation +func (s AssignTapePoolInput) String() string { + return awsutil.Prettify(s) +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AssignTapePoolInput) Validate() error { + invalidParams := aws.ErrInvalidParams{Context: "AssignTapePoolInput"} + + if s.PoolId == nil { + invalidParams.Add(aws.NewErrParamRequired("PoolId")) + } + if s.PoolId != nil && len(*s.PoolId) < 1 { + invalidParams.Add(aws.NewErrParamMinLen("PoolId", 1)) + } + + if s.TapeARN == nil { + invalidParams.Add(aws.NewErrParamRequired("TapeARN")) + } + if s.TapeARN != nil && len(*s.TapeARN) < 50 { + invalidParams.Add(aws.NewErrParamMinLen("TapeARN", 50)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AssignTapePoolOutput +type AssignTapePoolOutput struct { + _ struct{} `type:"structure"` + + // The unique Amazon Resource Names (ARN) of the virtual tape that was added + // to the tape pool. + TapeARN *string `min:"50" type:"string"` +} + +// String returns the string representation +func (s AssignTapePoolOutput) String() string { + return awsutil.Prettify(s) +} + +const opAssignTapePool = "AssignTapePool" + +// AssignTapePoolRequest returns a request value for making API operation for +// AWS Storage Gateway. +// +// Assigns a tape to a tape pool for archiving. The tape assigned to a 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 S3 storage class (Glacier or Deep Archive) that corresponds to the +// pool. +// +// Valid values: "GLACIER", "DEEP_ARCHIVE" +// +// // Example sending a request using AssignTapePoolRequest. +// req := client.AssignTapePoolRequest(params) +// resp, err := req.Send(context.TODO()) +// if err == nil { +// fmt.Println(resp) +// } +// +// Please also see https://docs.aws.amazon.com/goto/WebAPI/storagegateway-2013-06-30/AssignTapePool +func (c *Client) AssignTapePoolRequest(input *AssignTapePoolInput) AssignTapePoolRequest { + op := &aws.Operation{ + Name: opAssignTapePool, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &AssignTapePoolInput{} + } + + req := c.newRequest(op, input, &AssignTapePoolOutput{}) + return AssignTapePoolRequest{Request: req, Input: input, Copy: c.AssignTapePoolRequest} +} + +// AssignTapePoolRequest is the request type for the +// AssignTapePool API operation. +type AssignTapePoolRequest struct { + *aws.Request + Input *AssignTapePoolInput + Copy func(*AssignTapePoolInput) AssignTapePoolRequest +} + +// Send marshals and sends the AssignTapePool API request. +func (r AssignTapePoolRequest) Send(ctx context.Context) (*AssignTapePoolResponse, error) { + r.Request.SetContext(ctx) + err := r.Request.Send() + if err != nil { + return nil, err + } + + resp := &AssignTapePoolResponse{ + AssignTapePoolOutput: r.Request.Data.(*AssignTapePoolOutput), + response: &aws.Response{Request: r.Request}, + } + + return resp, nil +} + +// AssignTapePoolResponse is the response type for the +// AssignTapePool API operation. +type AssignTapePoolResponse struct { + *AssignTapePoolOutput + + response *aws.Response +} + +// SDKResponseMetdata returns the response metadata for the +// AssignTapePool request. +func (r *AssignTapePoolResponse) SDKResponseMetdata() *aws.Response { + return r.response +} diff --git a/service/storagegateway/storagegatewayiface/interface.go b/service/storagegateway/storagegatewayiface/interface.go index ed3bf1a0799..9f1d897c6f9 100644 --- a/service/storagegateway/storagegatewayiface/interface.go +++ b/service/storagegateway/storagegatewayiface/interface.go @@ -71,6 +71,8 @@ type ClientAPI interface { AddWorkingStorageRequest(*storagegateway.AddWorkingStorageInput) storagegateway.AddWorkingStorageRequest + AssignTapePoolRequest(*storagegateway.AssignTapePoolInput) storagegateway.AssignTapePoolRequest + AttachVolumeRequest(*storagegateway.AttachVolumeInput) storagegateway.AttachVolumeRequest CancelArchivalRequest(*storagegateway.CancelArchivalInput) storagegateway.CancelArchivalRequest diff --git a/service/sts/api_doc.go b/service/sts/api_doc.go index 1e66bb8a3ae..b3480b00a9a 100644 --- a/service/sts/api_doc.go +++ b/service/sts/api_doc.go @@ -9,14 +9,6 @@ // This guide provides descriptions of the STS API. For more detailed information // about using this service, go to Temporary Security Credentials (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html). // -// As an alternative to using the API, you can use one of the AWS SDKs, which -// consist of libraries and sample code for various programming languages and -// platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient -// way to create programmatic access to STS. For example, the SDKs take care -// of cryptographically signing requests, managing errors, and retrying requests -// automatically. For information about the AWS SDKs, including how to download -// and install them, see the Tools for Amazon Web Services page (http://aws.amazon.com/tools/). -// // For information about setting up signatures and authorization through the // API, go to Signing AWS API Requests (https://docs.aws.amazon.com/general/latest/gr/signing_aws_api_requests.html) // in the AWS General Reference. For general information about the Query API, @@ -53,11 +45,11 @@ // in the IAM User Guide. // // After you activate a Region for use with AWS STS, you can direct AWS STS -// API calls to that Region. AWS STS recommends that you use both the setRegion -// and setEndpoint methods to make calls to a Regional endpoint. You can use -// the setRegion method alone for manually enabled Regions, such as Asia Pacific -// (Hong Kong). In this case, the calls are directed to the STS Regional endpoint. -// However, if you use the setRegion method alone for Regions enabled by default, +// API calls to that Region. AWS STS recommends that you provide both the Region +// and endpoint when you make calls to a Regional endpoint. You can provide +// the Region alone for manually enabled Regions, such as Asia Pacific (Hong +// Kong). In this case, the calls are directed to the STS Regional endpoint. +// However, if you provide the Region alone for Regions enabled by default, // the calls are directed to the global endpoint of https://sts.amazonaws.com. // // To view the list of AWS STS endpoints and whether they are active by default, diff --git a/service/sts/api_op_AssumeRole.go b/service/sts/api_op_AssumeRole.go index 3e22e78ad45..3aa693b703e 100644 --- a/service/sts/api_op_AssumeRole.go +++ b/service/sts/api_op_AssumeRole.go @@ -60,7 +60,7 @@ type AssumeRoleInput struct { // 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/IAM/latest/UserGuide/access_policies.html#policies_session) + // 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 @@ -98,7 +98,7 @@ type AssumeRoleInput struct { // 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/IAM/latest/UserGuide/access_policies.html#policies_session) + // For more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. PolicyArns []PolicyDescriptorType `type:"list"` @@ -282,7 +282,7 @@ const opAssumeRole = "AssumeRole" // 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/IAM/latest/UserGuide/access_policies.html#policies_session) +// information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. // // To assume a role from a different account, your AWS account must be trusted diff --git a/service/sts/api_op_AssumeRoleWithSAML.go b/service/sts/api_op_AssumeRoleWithSAML.go index 2551b8984da..1277ff97703 100644 --- a/service/sts/api_op_AssumeRoleWithSAML.go +++ b/service/sts/api_op_AssumeRoleWithSAML.go @@ -46,7 +46,7 @@ type AssumeRoleWithSAMLInput struct { // 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/IAM/latest/UserGuide/access_policies.html#policies_session) + // 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 @@ -84,7 +84,7 @@ type AssumeRoleWithSAMLInput struct { // 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/IAM/latest/UserGuide/access_policies.html#policies_session) + // For more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. PolicyArns []PolicyDescriptorType `type:"list"` @@ -264,7 +264,7 @@ const opAssumeRoleWithSAML = "AssumeRoleWithSAML" // 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/IAM/latest/UserGuide/access_policies.html#policies_session) +// information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. // // Before your application can call AssumeRoleWithSAML, you must configure your diff --git a/service/sts/api_op_AssumeRoleWithWebIdentity.go b/service/sts/api_op_AssumeRoleWithWebIdentity.go index ba961a6eaa3..f971e77f644 100644 --- a/service/sts/api_op_AssumeRoleWithWebIdentity.go +++ b/service/sts/api_op_AssumeRoleWithWebIdentity.go @@ -43,7 +43,7 @@ type AssumeRoleWithWebIdentityInput struct { // 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/IAM/latest/UserGuide/access_policies.html#policies_session) + // 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 @@ -81,7 +81,7 @@ type AssumeRoleWithWebIdentityInput struct { // 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/IAM/latest/UserGuide/access_policies.html#policies_session) + // For more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. PolicyArns []PolicyDescriptorType `type:"list"` @@ -287,7 +287,7 @@ const opAssumeRoleWithWebIdentity = "AssumeRoleWithWebIdentity" // 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/IAM/latest/UserGuide/access_policies.html#policies_session) +// information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. // // Before your application can call AssumeRoleWithWebIdentity, you must have diff --git a/service/sts/api_op_GetFederationToken.go b/service/sts/api_op_GetFederationToken.go index 1f07d729c8c..f61041049de 100644 --- a/service/sts/api_op_GetFederationToken.go +++ b/service/sts/api_op_GetFederationToken.go @@ -52,7 +52,7 @@ type GetFederationTokenInput struct { // 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/IAM/latest/UserGuide/access_policies.html#policies_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 @@ -92,7 +92,7 @@ type GetFederationTokenInput struct { // 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/IAM/latest/UserGuide/access_policies.html#policies_session) + // Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. // // The characters in this parameter count towards the 2048 character session @@ -231,7 +231,7 @@ const opGetFederationToken = "GetFederationToken" // 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/IAM/latest/UserGuide/access_policies.html#policies_session) +// more information, see Session Policies (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) // in the IAM User Guide. For information about using GetFederationToken to // create temporary security credentials, see GetFederationToken—Federation // Through a Custom Identity Broker (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_request.html#api_getfederationtoken). diff --git a/service/transcribe/api_enums.go b/service/transcribe/api_enums.go index d8983904510..1c9eb7ed8df 100644 --- a/service/transcribe/api_enums.go +++ b/service/transcribe/api_enums.go @@ -19,6 +19,7 @@ const ( LanguageCodeEsEs LanguageCode = "es-ES" LanguageCodeEnIn LanguageCode = "en-IN" LanguageCodeHiIn LanguageCode = "hi-IN" + LanguageCodeArSa LanguageCode = "ar-SA" ) func (enum LanguageCode) MarshalValue() (string, error) { diff --git a/service/waf/api_op_CreateRateBasedRule.go b/service/waf/api_op_CreateRateBasedRule.go index 288816a9ca3..3470526f974 100644 --- a/service/waf/api_op_CreateRateBasedRule.go +++ b/service/waf/api_op_CreateRateBasedRule.go @@ -21,9 +21,10 @@ type CreateRateBasedRuleInput struct { ChangeToken *string `min:"1" type:"string" required:"true"` // A friendly name or description for the metrics for this RateBasedRule. The - // name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't - // contain whitespace. You can't change the name of the metric after you create - // the RateBasedRule. + // 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 is a required field MetricName *string `type:"string" required:"true"` diff --git a/service/waf/api_op_CreateRule.go b/service/waf/api_op_CreateRule.go index 2d76d4e275f..61573235726 100644 --- a/service/waf/api_op_CreateRule.go +++ b/service/waf/api_op_CreateRule.go @@ -19,9 +19,10 @@ type CreateRuleInput struct { ChangeToken *string `min:"1" type:"string" required:"true"` // A friendly name or description for the metrics for this Rule. The name can - // contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain - // white space. You can't change the name of the metric after you create the - // Rule. + // 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. // // MetricName is a required field MetricName *string `type:"string" required:"true"` diff --git a/service/waf/api_op_CreateRuleGroup.go b/service/waf/api_op_CreateRuleGroup.go index 0ff4fbeaaa6..21e81bb98fb 100644 --- a/service/waf/api_op_CreateRuleGroup.go +++ b/service/waf/api_op_CreateRuleGroup.go @@ -19,9 +19,10 @@ type CreateRuleGroupInput struct { ChangeToken *string `min:"1" type:"string" required:"true"` // A friendly name or description for the metrics for this RuleGroup. The name - // can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't - // contain whitespace. You can't change the name of the metric after you create - // the RuleGroup. + // 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 is a required field MetricName *string `type:"string" required:"true"` diff --git a/service/waf/api_op_CreateWebACL.go b/service/waf/api_op_CreateWebACL.go index 6f9df201011..5cc49137a0b 100644 --- a/service/waf/api_op_CreateWebACL.go +++ b/service/waf/api_op_CreateWebACL.go @@ -25,9 +25,11 @@ type CreateWebACLInput struct { // DefaultAction is a required field DefaultAction *WafAction `type:"structure" required:"true"` - // A friendly name or description for the metrics for this WebACL. The name - // can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't - // contain white space. You can't change MetricName after you create the WebACL. + // 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 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 WebACL. // // MetricName is a required field MetricName *string `type:"string" required:"true"` diff --git a/service/waf/api_op_PutLoggingConfiguration.go b/service/waf/api_op_PutLoggingConfiguration.go index c2ae17f6bd1..dac2394fe01 100644 --- a/service/waf/api_op_PutLoggingConfiguration.go +++ b/service/waf/api_op_PutLoggingConfiguration.go @@ -74,6 +74,8 @@ const opPutLoggingConfiguration = "PutLoggingConfiguration" // operating. However, if you are capturing logs for Amazon CloudFront, always // create the firehose in US East (N. Virginia). // +// Do not create the data firehose using a Kinesis stream as your source. +// // Associate that firehose to your web ACL using a PutLoggingConfiguration request. // // When you successfully enable logging using a PutLoggingConfiguration request, diff --git a/service/waf/api_types.go b/service/waf/api_types.go index 1d48112c1fb..b3c3e28a976 100644 --- a/service/waf/api_types.go +++ b/service/waf/api_types.go @@ -1129,9 +1129,10 @@ type RateBasedRule struct { MatchPredicates []Predicate `type:"list" required:"true"` // A friendly name or description for the metrics for a RateBasedRule. The name - // can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't - // contain whitespace. You can't change the name of the metric after you create - // the RateBasedRule. + // 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 `type:"string"` // A friendly name or description for a RateBasedRule. You can't change the @@ -1553,8 +1554,10 @@ type Rule struct { _ struct{} `type:"structure"` // A friendly name or description for the metrics for this Rule. The name can - // contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain - // whitespace. You can't change MetricName after you create the Rule. + // 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 `type:"string"` // The friendly name or description for the Rule. You can't change the name @@ -1598,9 +1601,10 @@ type RuleGroup struct { _ struct{} `type:"structure"` // A friendly name or description for the metrics for this RuleGroup. The name - // can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't - // contain whitespace. You can't change the name of the metric after you create - // the RuleGroup. + // 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 `type:"string"` // The friendly name or description for the RuleGroup. You can't change the @@ -2314,9 +2318,10 @@ type SubscribedRuleGroupSummary struct { _ struct{} `type:"structure"` // A friendly name or description for the metrics for this RuleGroup. The name - // can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't - // contain whitespace. You can't change the name of the metric after you create - // the RuleGroup. + // 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 is a required field MetricName *string `type:"string" required:"true"` @@ -2484,8 +2489,10 @@ type WebACL struct { DefaultAction *WafAction `type:"structure" required:"true"` // A friendly name or description for the metrics for this WebACL. The name - // can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't - // contain whitespace. You can't change MetricName after you create the WebACL. + // 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 WebACL. MetricName *string `type:"string"` // A friendly name or description of the WebACL. You can't change the name of