From fbcb84075f34cff62f00dffc2fa1b7899b4a2ac2 Mon Sep 17 00:00:00 2001 From: awssdkgo Date: Thu, 18 Nov 2021 19:23:04 +0000 Subject: [PATCH] Release v1.42.8 (2021-11-18) === ### Service Client Updates * `service/appconfig`: Updates service API, documentation, and examples * `service/auditmanager`: Updates service API, documentation, and paginators * `service/chime`: Updates service API and documentation * Adds new Transcribe API parameters to StartMeetingTranscription, including support for content identification and redaction (PII & PHI), partial results stabilization, and custom language models. * `service/chime-sdk-meetings`: Updates service API and documentation * `service/databrew`: Updates service API, documentation, and paginators * `service/forecast`: Updates service API and documentation * `service/ivs`: Updates service API, documentation, and paginators * `service/kafka`: Updates service API and documentation * `service/lambda`: Updates service API and documentation * Added support for CLIENT_CERTIFICATE_TLS_AUTH and SERVER_ROOT_CA_CERTIFICATE as SourceAccessType for MSK and Kafka event source mappings. * `service/models.lex.v2`: Updates service API and documentation * `service/monitoring`: Updates service API and documentation * CloudWatch Anomaly Detection now supports anomaly detectors that use metric math as input. * `service/redshift-data`: Updates service API and documentation --- CHANGELOG.md | 20 + aws/endpoints/defaults.go | 43 + aws/version.go | 2 +- models/apis/appconfig/2019-10-09/api-2.json | 54 +- models/apis/appconfig/2019-10-09/docs-2.json | 150 +- .../apis/appconfig/2019-10-09/examples-1.json | 715 ++ .../apis/auditmanager/2017-07-25/api-2.json | 308 + .../apis/auditmanager/2017-07-25/docs-2.json | 235 +- .../auditmanager/2017-07-25/paginators-1.json | 20 + .../chime-sdk-meetings/2021-07-15/api-2.json | 44 +- .../chime-sdk-meetings/2021-07-15/docs-2.json | 46 +- models/apis/chime/2018-05-01/api-2.json | 43 +- models/apis/chime/2018-05-01/docs-2.json | 39 +- models/apis/databrew/2017-07-25/api-2.json | 382 +- models/apis/databrew/2017-07-25/docs-2.json | 266 +- .../databrew/2017-07-25/paginators-1.json | 6 + models/apis/forecast/2018-06-26/api-2.json | 491 +- models/apis/forecast/2018-06-26/docs-2.json | 329 +- models/apis/ivs/2020-07-14/api-2.json | 150 + models/apis/ivs/2020-07-14/docs-2.json | 133 +- models/apis/ivs/2020-07-14/paginators-1.json | 5 + models/apis/kafka/2018-11-14/api-2.json | 111 + models/apis/kafka/2018-11-14/docs-2.json | 60 +- models/apis/lambda/2015-03-31/api-2.json | 4 +- models/apis/lambda/2015-03-31/docs-2.json | 26 +- .../apis/models.lex.v2/2020-08-07/api-2.json | 10 +- .../apis/models.lex.v2/2020-08-07/docs-2.json | 54 +- models/apis/monitoring/2010-08-01/api-2.json | 134 +- models/apis/monitoring/2010-08-01/docs-2.json | 59 +- .../apis/redshift-data/2019-12-20/api-2.json | 46 +- .../apis/redshift-data/2019-12-20/docs-2.json | 50 +- models/endpoints/endpoints.json | 17 + service/appconfig/api.go | 543 +- service/appconfig/doc.go | 16 +- service/appconfig/errors.go | 5 +- service/appconfig/examples_test.go | 1194 +++ service/auditmanager/api.go | 4571 +++++++--- .../auditmanageriface/interface.go | 36 + service/chime/api.go | 140 + service/chime/doc.go | 9 +- service/chimesdkmeetings/api.go | 147 +- service/chimesdkmeetings/doc.go | 3 +- service/cloudwatch/api.go | 431 +- service/forecastservice/api.go | 7783 ++++++++++++----- .../forecastserviceiface/interface.go | 44 +- service/gluedatabrew/api.go | 2207 ++++- .../gluedatabrewiface/interface.go | 23 + service/ivs/api.go | 970 +- service/ivs/doc.go | 305 +- service/ivs/ivsiface/interface.go | 11 + service/kafka/api.go | 371 +- service/kafka/kafkaiface/interface.go | 4 + service/lambda/api.go | 110 +- service/lambda/doc.go | 71 +- service/lexmodelsv2/api.go | 102 +- service/redshiftdataapiservice/api.go | 270 +- service/redshiftdataapiservice/errors.go | 7 - 57 files changed, 18950 insertions(+), 4475 deletions(-) create mode 100644 service/appconfig/examples_test.go diff --git a/CHANGELOG.md b/CHANGELOG.md index d2b07e25a4..254a584d0d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,23 @@ +Release v1.42.8 (2021-11-18) +=== + +### Service Client Updates +* `service/appconfig`: Updates service API, documentation, and examples +* `service/auditmanager`: Updates service API, documentation, and paginators +* `service/chime`: Updates service API and documentation + * Adds new Transcribe API parameters to StartMeetingTranscription, including support for content identification and redaction (PII & PHI), partial results stabilization, and custom language models. +* `service/chime-sdk-meetings`: Updates service API and documentation +* `service/databrew`: Updates service API, documentation, and paginators +* `service/forecast`: Updates service API and documentation +* `service/ivs`: Updates service API, documentation, and paginators +* `service/kafka`: Updates service API and documentation +* `service/lambda`: Updates service API and documentation + * Added support for CLIENT_CERTIFICATE_TLS_AUTH and SERVER_ROOT_CA_CERTIFICATE as SourceAccessType for MSK and Kafka event source mappings. +* `service/models.lex.v2`: Updates service API and documentation +* `service/monitoring`: Updates service API and documentation + * CloudWatch Anomaly Detection now supports anomaly detectors that use metric math as input. +* `service/redshift-data`: Updates service API and documentation + Release v1.42.7 (2021-11-17) === diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go index a08a84bb29..d1a31f510c 100644 --- a/aws/endpoints/defaults.go +++ b/aws/endpoints/defaults.go @@ -5785,6 +5785,37 @@ var awsPartition = partition{ }, }, }, + "drs": service{ + Endpoints: serviceEndpoints{ + endpointKey{ + Region: "ap-northeast-1", + }: endpoint{}, + endpointKey{ + Region: "ap-southeast-1", + }: endpoint{}, + endpointKey{ + Region: "ap-southeast-2", + }: endpoint{}, + endpointKey{ + Region: "eu-central-1", + }: endpoint{}, + endpointKey{ + Region: "eu-west-1", + }: endpoint{}, + endpointKey{ + Region: "eu-west-2", + }: endpoint{}, + endpointKey{ + Region: "us-east-1", + }: endpoint{}, + endpointKey{ + Region: "us-east-2", + }: endpoint{}, + endpointKey{ + Region: "us-west-2", + }: endpoint{}, + }, + }, "ds": service{ Endpoints: serviceEndpoints{ endpointKey{ @@ -12698,6 +12729,9 @@ var awsPartition = partition{ }, "mgn": service{ Endpoints: serviceEndpoints{ + endpointKey{ + Region: "af-south-1", + }: endpoint{}, endpointKey{ Region: "ap-east-1", }: endpoint{}, @@ -12728,12 +12762,21 @@ var awsPartition = partition{ endpointKey{ Region: "eu-north-1", }: endpoint{}, + endpointKey{ + Region: "eu-south-1", + }: endpoint{}, endpointKey{ Region: "eu-west-1", }: endpoint{}, endpointKey{ Region: "eu-west-2", }: endpoint{}, + endpointKey{ + Region: "eu-west-3", + }: endpoint{}, + endpointKey{ + Region: "me-south-1", + }: endpoint{}, endpointKey{ Region: "sa-east-1", }: endpoint{}, diff --git a/aws/version.go b/aws/version.go index 0c20299e92..c81b4abf46 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 = "1.42.7" +const SDKVersion = "1.42.8" diff --git a/models/apis/appconfig/2019-10-09/api-2.json b/models/apis/appconfig/2019-10-09/api-2.json index ddec94e94e..e0bc074fe6 100644 --- a/models/apis/appconfig/2019-10-09/api-2.json +++ b/models/apis/appconfig/2019-10-09/api-2.json @@ -529,14 +529,27 @@ "min":20, "pattern":"arn:(aws[a-zA-Z-]*)?:[a-z]+:([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1})?:(\\d{12})?:[a-zA-Z0-9-_/:.]+" }, + "BadRequestDetails":{ + "type":"structure", + "members":{ + "InvalidConfiguration":{"shape":"InvalidConfigurationDetailList"} + }, + "union":true + }, "BadRequestException":{ "type":"structure", "members":{ - "Message":{"shape":"String"} + "Message":{"shape":"String"}, + "Reason":{"shape":"BadRequestReason"}, + "Details":{"shape":"BadRequestDetails"} }, "error":{"httpStatusCode":400}, "exception":true }, + "BadRequestReason":{ + "type":"string", + "enum":["InvalidConfiguration"] + }, "Blob":{ "type":"blob", "sensitive":true @@ -571,7 +584,8 @@ "Description":{"shape":"Description"}, "LocationUri":{"shape":"Uri"}, "RetrievalRoleArn":{"shape":"RoleArn"}, - "Validators":{"shape":"ValidatorList"} + "Validators":{"shape":"ValidatorList"}, + "Type":{"shape":"ConfigurationProfileType"} } }, "ConfigurationProfileSummary":{ @@ -581,13 +595,18 @@ "Id":{"shape":"Id"}, "Name":{"shape":"Name"}, "LocationUri":{"shape":"Uri"}, - "ValidatorTypes":{"shape":"ValidatorTypeList"} + "ValidatorTypes":{"shape":"ValidatorTypeList"}, + "Type":{"shape":"ConfigurationProfileType"} } }, "ConfigurationProfileSummaryList":{ "type":"list", "member":{"shape":"ConfigurationProfileSummary"} }, + "ConfigurationProfileType":{ + "type":"string", + "pattern":"^[a-zA-Z\\.]+" + }, "ConfigurationProfiles":{ "type":"structure", "members":{ @@ -630,7 +649,8 @@ "LocationUri":{"shape":"Uri"}, "RetrievalRoleArn":{"shape":"RoleArn"}, "Validators":{"shape":"ValidatorList"}, - "Tags":{"shape":"TagMap"} + "Tags":{"shape":"TagMap"}, + "Type":{"shape":"ConfigurationProfileType"} } }, "CreateDeploymentStrategyRequest":{ @@ -1176,6 +1196,19 @@ "exception":true, "fault":true }, + "InvalidConfigurationDetail":{ + "type":"structure", + "members":{ + "Constraint":{"shape":"String"}, + "Location":{"shape":"String"}, + "Reason":{"shape":"String"}, + "Type":{"shape":"String"} + } + }, + "InvalidConfigurationDetailList":{ + "type":"list", + "member":{"shape":"InvalidConfigurationDetail"} + }, "Iso8601DateTime":{ "type":"timestamp", "timestampFormat":"iso8601" @@ -1215,6 +1248,11 @@ "shape":"NextToken", "location":"querystring", "locationName":"next_token" + }, + "Type":{ + "shape":"ConfigurationProfileType", + "location":"querystring", + "locationName":"type" } } }, @@ -1339,8 +1377,9 @@ }, "Monitor":{ "type":"structure", + "required":["AlarmArn"], "members":{ - "AlarmArn":{"shape":"Arn"}, + "AlarmArn":{"shape":"StringWithLengthBetween1And2048"}, "AlarmRoleArn":{"shape":"RoleArn"} } }, @@ -1472,6 +1511,11 @@ "min":0, "sensitive":true }, + "StringWithLengthBetween1And2048":{ + "type":"string", + "max":2048, + "min":1 + }, "StringWithLengthBetween1And255":{ "type":"string", "max":255, diff --git a/models/apis/appconfig/2019-10-09/docs-2.json b/models/apis/appconfig/2019-10-09/docs-2.json index 57705e22b8..57d9c63c6c 100644 --- a/models/apis/appconfig/2019-10-09/docs-2.json +++ b/models/apis/appconfig/2019-10-09/docs-2.json @@ -1,34 +1,34 @@ { "version": "2.0", - "service": "AWS AppConfig

Use AWS AppConfig, a capability of AWS Systems Manager, to create, manage, and quickly deploy application configurations. AppConfig supports controlled deployments to applications of any size and includes built-in validation checks and monitoring. You can use AppConfig with applications hosted on Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT devices.

To prevent errors when deploying application configurations, especially for production systems where a simple typo could cause an unexpected outage, AppConfig includes validators. A validator provides a syntactic or semantic check to ensure that the configuration you want to deploy works as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.

During a configuration deployment, AppConfig monitors the application to ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can configure a deployment strategy for each application or environment that includes deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back to the previous version.

AppConfig supports multiple use cases. Here are some examples.

This reference is intended to be used with the AWS AppConfig User Guide.

", + "service": "

Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy application configurations. AppConfig supports controlled deployments to applications of any size and includes built-in validation checks and monitoring. You can use AppConfig with applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT devices.

To prevent errors when deploying application configurations, especially for production systems where a simple typo could cause an unexpected outage, AppConfig includes validators. A validator provides a syntactic or semantic check to ensure that the configuration you want to deploy works as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.

During a configuration deployment, AppConfig monitors the application to ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can configure a deployment strategy for each application or environment that includes deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back to the previous version.

AppConfig supports multiple use cases. Here are some examples:

This reference is intended to be used with the AppConfig User Guide.

", "operations": { - "CreateApplication": "

An application in AppConfig is a logical unit of code that provides capabilities for your customers. For example, an application can be a microservice that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless application using Amazon API Gateway and AWS Lambda, or any system you run on behalf of others.

", - "CreateConfigurationProfile": "

Information that enables AppConfig to access the configuration source. Valid configuration sources include Systems Manager (SSM) documents, SSM Parameter Store parameters, and Amazon S3 objects. A configuration profile includes the following information.

For more information, see Create a Configuration and a Configuration Profile in the AWS AppConfig User Guide.

", - "CreateDeploymentStrategy": "

A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

", - "CreateEnvironment": "

For each application, you define one or more environments. An environment is a logical deployment group of AppConfig targets, such as applications in a Beta or Production environment. You can also define environments for application subcomponents such as the Web, Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

", - "CreateHostedConfigurationVersion": "

Create a new configuration in the AppConfig configuration store.

", - "DeleteApplication": "

Delete an application. Deleting an application does not delete a configuration from a host.

", - "DeleteConfigurationProfile": "

Delete a configuration profile. Deleting a configuration profile does not delete a configuration from a host.

", - "DeleteDeploymentStrategy": "

Delete a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.

", - "DeleteEnvironment": "

Delete an environment. Deleting an environment does not delete a configuration from a host.

", - "DeleteHostedConfigurationVersion": "

Delete a version of a configuration from the AppConfig configuration store.

", - "GetApplication": "

Retrieve information about an application.

", - "GetConfiguration": "

Receive information about a configuration.

AWS AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration.

To avoid excess charges, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.

", - "GetConfigurationProfile": "

Retrieve information about a configuration profile.

", - "GetDeployment": "

Retrieve information about a configuration deployment.

", - "GetDeploymentStrategy": "

Retrieve information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

", - "GetEnvironment": "

Retrieve information about an environment. An environment is a logical deployment group of AppConfig applications, such as applications in a Production environment or in an EU_Region environment. Each configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.

", - "GetHostedConfigurationVersion": "

Get information about a specific configuration version.

", - "ListApplications": "

List all applications in your AWS account.

", + "CreateApplication": "

Creates an application. An application in AppConfig is a logical unit of code that provides capabilities for your customers. For example, an application can be a microservice that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless application using Amazon API Gateway and Lambda, or any system you run on behalf of others.

", + "CreateConfigurationProfile": "

Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the AppConfig hosted configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3 objects, or any integration source action supported by CodePipeline. A configuration profile includes the following information:

For more information, see Create a Configuration and a Configuration Profile in the AppConfig User Guide.

", + "CreateDeploymentStrategy": "

Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

", + "CreateEnvironment": "

Creates an environment. For each application, you define one or more environments. An environment is a logical deployment group of AppConfig targets, such as applications in a Beta or Production environment. You can also define environments for application subcomponents such as the Web, Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

", + "CreateHostedConfigurationVersion": "

Creates a new configuration in the AppConfig hosted configuration store.

", + "DeleteApplication": "

Deletes an application. Deleting an application does not delete a configuration from a host.

", + "DeleteConfigurationProfile": "

Deletes a configuration profile. Deleting a configuration profile does not delete a configuration from a host.

", + "DeleteDeploymentStrategy": "

Deletes a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.

", + "DeleteEnvironment": "

Deletes an environment. Deleting an environment does not delete a configuration from a host.

", + "DeleteHostedConfigurationVersion": "

Deletes a version of a configuration from the AppConfig hosted configuration store.

", + "GetApplication": "

Retrieves information about an application.

", + "GetConfiguration": "

Retrieves information about a configuration.

AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration.

To avoid excess charges, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.

", + "GetConfigurationProfile": "

Retrieves information about a configuration profile.

", + "GetDeployment": "

Retrieves information about a configuration deployment.

", + "GetDeploymentStrategy": "

Retrieves information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

", + "GetEnvironment": "

Retrieves information about an environment. An environment is a logical deployment group of AppConfig applications, such as applications in a Production environment or in an EU_Region environment. Each configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.

", + "GetHostedConfigurationVersion": "

Retrieves information about a specific configuration version.

", + "ListApplications": "

Lists all applications in your Amazon Web Services account.

", "ListConfigurationProfiles": "

Lists the configuration profiles for an application.

", - "ListDeploymentStrategies": "

List deployment strategies.

", + "ListDeploymentStrategies": "

Lists deployment strategies.

", "ListDeployments": "

Lists the deployments for an environment.

", - "ListEnvironments": "

List the environments for an application.

", - "ListHostedConfigurationVersions": "

View a list of configurations stored in the AppConfig configuration store by version.

", + "ListEnvironments": "

Lists the environments for an application.

", + "ListHostedConfigurationVersions": "

Lists configurations stored in the AppConfig hosted configuration store by version.

", "ListTagsForResource": "

Retrieves the list of key-value tags assigned to the resource.

", "StartDeployment": "

Starts a deployment.

", "StopDeployment": "

Stops a deployment. This API action works only on deployments that have a status of DEPLOYING. This action moves the deployment to a status of ROLLED_BACK.

", - "TagResource": "

Metadata to assign to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.

", + "TagResource": "

Assigns metadata to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.

", "UntagResource": "

Deletes a tag key and value from an AppConfig resource.

", "UpdateApplication": "

Updates an application.

", "UpdateConfigurationProfile": "

Updates a configuration profile.

", @@ -58,20 +58,31 @@ "base": null, "refs": { "ListTagsForResourceRequest$ResourceArn": "

The resource ARN.

", - "Monitor$AlarmArn": "

ARN of the Amazon CloudWatch alarm.

", "TagResourceRequest$ResourceArn": "

The ARN of the resource for which to retrieve tags.

", "UntagResourceRequest$ResourceArn": "

The ARN of the resource for which to remove tags.

" } }, + "BadRequestDetails": { + "base": "

Detailed information about the input that failed to satisfy the constraints specified by an AWS service.

", + "refs": { + "BadRequestException$Details": null + } + }, "BadRequestException": { - "base": "

The input fails to satisfy the constraints specified by an AWS service.

", + "base": "

The input fails to satisfy the constraints specified by an Amazon Web Services service.

", "refs": { } }, + "BadRequestReason": { + "base": null, + "refs": { + "BadRequestException$Reason": null + } + }, "Blob": { "base": null, "refs": { - "Configuration$Content": "

The content of the configuration or the configuration data.

", + "Configuration$Content": "

The content of the configuration or the configuration data.

Compare the configuration version numbers of the configuration cached locally on your machine and the configuration number in the the header. If the configuration numbers are the same, the content can be ignored. The Content section only appears if the system finds new or updated configuration data. If the system doesn't find new or updated configuration data, then the Content section is not returned.

", "CreateHostedConfigurationVersionRequest$Content": "

The content of the configuration or the configuration data.

", "HostedConfigurationVersion$Content": "

The content of the configuration or the configuration data.

" } @@ -104,6 +115,15 @@ "ConfigurationProfiles$Items": "

The elements from this collection.

" } }, + "ConfigurationProfileType": { + "base": null, + "refs": { + "ConfigurationProfile$Type": "

The type of configurations that the configuration profile contains. A configuration can be a feature flag used for enabling or disabling new features or a free-form configuration used for distributing configurations to your application.

", + "ConfigurationProfileSummary$Type": "

The type of configurations that the configuration profile contains. A configuration can be a feature flag used for enabling or disabling new features or a free-form configuration used to introduce changes to your application.

", + "CreateConfigurationProfileRequest$Type": "

The type of configurations that the configuration profile contains. A configuration can be a feature flag used for enabling or disabling new features or a free-form configuration used for distributing configurations to your application.

", + "ListConfigurationProfilesRequest$Type": "

A filter based on the type of configurations that the configuration profile contains. A configuration can be a feature flag or a free-form configuration.

" + } + }, "ConfigurationProfiles": { "base": null, "refs": { @@ -178,7 +198,7 @@ "DeploymentEventType": { "base": null, "refs": { - "DeploymentEvent$EventType": "

The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; the start or completion of a rollback.

" + "DeploymentEvent$EventType": "

The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; and the start or completion of a rollback.

" } }, "DeploymentEvents": { @@ -248,7 +268,7 @@ "CreateEnvironmentRequest$Description": "

A description of the environment.

", "CreateHostedConfigurationVersionRequest$Description": "

A description of the configuration.

", "Deployment$Description": "

The description of the deployment.

", - "DeploymentEvent$Description": "

A description of the deployment event. Descriptions include, but are not limited to, the user account or the CloudWatch alarm ARN that initiated a rollback, the percentage of hosts that received the deployment, or in the case of an internal error, a recommendation to attempt a new deployment.

", + "DeploymentEvent$Description": "

A description of the deployment event. Descriptions include, but are not limited to, the user account or the Amazon CloudWatch alarm ARN that initiated a rollback, the percentage of hosts that received the deployment, or in the case of an internal error, a recommendation to attempt a new deployment.

", "DeploymentStrategy$Description": "

The description of the deployment strategy.

", "Environment$Description": "

The description of the environment.

", "HostedConfigurationVersion$Description": "

A description of the configuration.

", @@ -335,11 +355,11 @@ "GrowthType": { "base": null, "refs": { - "CreateDeploymentStrategyRequest$GrowthType": "

The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.

Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

2*(2^0)

2*(2^1)

2*(2^2)

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

", + "CreateDeploymentStrategyRequest$GrowthType": "

The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.

Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

2*(2^0)

2*(2^1)

2*(2^2)

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

", "Deployment$GrowthType": "

The algorithm used to define how percentage grew over time.

", "DeploymentStrategy$GrowthType": "

The algorithm used to define how percentage grew over time.

", "DeploymentSummary$GrowthType": "

The algorithm used to define how percentage grows over time.

", - "UpdateDeploymentStrategyRequest$GrowthType": "

The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.

Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

2*(2^0)

2*(2^1)

2*(2^2)

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

" + "UpdateDeploymentStrategyRequest$GrowthType": "

The algorithm used to define how percentage grows over time. AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.

Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

2*(2^0)

2*(2^1)

2*(2^2)

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

" } }, "HostedConfigurationVersion": { @@ -379,8 +399,8 @@ "DeleteApplicationRequest$ApplicationId": "

The ID of the application to delete.

", "DeleteConfigurationProfileRequest$ApplicationId": "

The application ID that includes the configuration profile you want to delete.

", "DeleteConfigurationProfileRequest$ConfigurationProfileId": "

The ID of the configuration profile you want to delete.

", - "DeleteEnvironmentRequest$ApplicationId": "

The application ID that includes the environment you want to delete.

", - "DeleteEnvironmentRequest$EnvironmentId": "

The ID of the environment you want to delete.

", + "DeleteEnvironmentRequest$ApplicationId": "

The application ID that includes the environment that you want to delete.

", + "DeleteEnvironmentRequest$EnvironmentId": "

The ID of the environment that you want to delete.

", "DeleteHostedConfigurationVersionRequest$ApplicationId": "

The application ID.

", "DeleteHostedConfigurationVersionRequest$ConfigurationProfileId": "

The configuration profile ID.

", "Deployment$ApplicationId": "

The ID of the application that was deployed.

", @@ -392,11 +412,11 @@ "Environment$Id": "

The environment ID.

", "GetApplicationRequest$ApplicationId": "

The ID of the application you want to get.

", "GetConfigurationProfileRequest$ApplicationId": "

The ID of the application that includes the configuration profile you want to get.

", - "GetConfigurationProfileRequest$ConfigurationProfileId": "

The ID of the configuration profile you want to get.

", + "GetConfigurationProfileRequest$ConfigurationProfileId": "

The ID of the configuration profile that you want to get.

", "GetDeploymentRequest$ApplicationId": "

The ID of the application that includes the deployment you want to get.

", "GetDeploymentRequest$EnvironmentId": "

The ID of the environment that includes the deployment you want to get.

", "GetEnvironmentRequest$ApplicationId": "

The ID of the application that includes the environment you want to get.

", - "GetEnvironmentRequest$EnvironmentId": "

The ID of the environment you wnat to get.

", + "GetEnvironmentRequest$EnvironmentId": "

The ID of the environment that you want to get.

", "GetHostedConfigurationVersionRequest$ApplicationId": "

The application ID.

", "GetHostedConfigurationVersionRequest$ConfigurationProfileId": "

The configuration profile ID.

", "HostedConfigurationVersion$ApplicationId": "

The application ID.

", @@ -426,7 +446,7 @@ "Integer": { "base": null, "refs": { - "CreateHostedConfigurationVersionRequest$LatestVersionNumber": "

An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version of the latest hosted configuration version.

", + "CreateHostedConfigurationVersionRequest$LatestVersionNumber": "

An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.

", "DeleteHostedConfigurationVersionRequest$VersionNumber": "

The versions number to delete.

", "Deployment$DeploymentNumber": "

The sequence number of the deployment.

", "DeploymentSummary$DeploymentNumber": "

The sequence number of the deployment.

", @@ -442,6 +462,18 @@ "refs": { } }, + "InvalidConfigurationDetail": { + "base": "

Detailed information about the bad request exception error when creating a hosted configuration version.

", + "refs": { + "InvalidConfigurationDetailList$member": null + } + }, + "InvalidConfigurationDetailList": { + "base": null, + "refs": { + "BadRequestDetails$InvalidConfiguration": "

Detailed information about the bad request exception error when creating a hosted configuration version.

" + } + }, "Iso8601DateTime": { "base": null, "refs": { @@ -504,13 +536,13 @@ "CreateDeploymentStrategyRequest$DeploymentDurationInMinutes": "

Total amount of time for a deployment to last.

", "CreateDeploymentStrategyRequest$FinalBakeTimeInMinutes": "

The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

", "Deployment$DeploymentDurationInMinutes": "

Total amount of time the deployment lasted.

", - "Deployment$FinalBakeTimeInMinutes": "

The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

", + "Deployment$FinalBakeTimeInMinutes": "

The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

", "DeploymentStrategy$DeploymentDurationInMinutes": "

Total amount of time the deployment lasted.

", - "DeploymentStrategy$FinalBakeTimeInMinutes": "

The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

", + "DeploymentStrategy$FinalBakeTimeInMinutes": "

The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

", "DeploymentSummary$DeploymentDurationInMinutes": "

Total amount of time the deployment lasted.

", - "DeploymentSummary$FinalBakeTimeInMinutes": "

The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

", + "DeploymentSummary$FinalBakeTimeInMinutes": "

The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

", "UpdateDeploymentStrategyRequest$DeploymentDurationInMinutes": "

Total amount of time for a deployment to last.

", - "UpdateDeploymentStrategyRequest$FinalBakeTimeInMinutes": "

The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

" + "UpdateDeploymentStrategyRequest$FinalBakeTimeInMinutes": "

The amount of time that AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

" } }, "Monitor": { @@ -555,7 +587,7 @@ "Deployments$NextToken": "

The token for the next set of items to return. Use this token to get the next set of results.

", "Environments$NextToken": "

The token for the next set of items to return. Use this token to get the next set of results.

", "HostedConfigurationVersions$NextToken": "

The token for the next set of items to return. Use this token to get the next set of results.

", - "ListApplicationsRequest$NextToken": "

A token to start the list. Use this token to get the next set of results.

", + "ListApplicationsRequest$NextToken": "

A token to start the list. Next token is a pagination token generated by AppConfig to describe what page the previous List call ended on. For the first List request, the nextToken should not be set. On subsequent calls, the nextToken parameter should be set to the previous responses nextToken value. Use this token to get the next set of results.

", "ListConfigurationProfilesRequest$NextToken": "

A token to start the list. Use this token to get the next set of results.

", "ListDeploymentStrategiesRequest$NextToken": "

A token to start the list. Use this token to get the next set of results.

", "ListDeploymentsRequest$NextToken": "

A token to start the list. Use this token to get the next set of results.

", @@ -598,14 +630,14 @@ "RoleArn": { "base": null, "refs": { - "ConfigurationProfile$RetrievalRoleArn": "

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

", - "CreateConfigurationProfileRequest$RetrievalRoleArn": "

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

", - "Monitor$AlarmRoleArn": "

ARN of an IAM role for AppConfig to monitor AlarmArn.

", - "UpdateConfigurationProfileRequest$RetrievalRoleArn": "

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

" + "ConfigurationProfile$RetrievalRoleArn": "

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

", + "CreateConfigurationProfileRequest$RetrievalRoleArn": "

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that store your configuration.

", + "Monitor$AlarmRoleArn": "

ARN of an Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn.

", + "UpdateConfigurationProfileRequest$RetrievalRoleArn": "

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

" } }, "ServiceQuotaExceededException": { - "base": "

The number of hosted configuration versions exceeds the limit for the AppConfig configuration store. Delete one or more versions and try again.

", + "base": "

The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.

", "refs": { } }, @@ -626,6 +658,10 @@ "Configuration$ContentType": "

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

", "ConflictException$Message": null, "InternalServerException$Message": null, + "InvalidConfigurationDetail$Constraint": "

The invalid or out-of-range validation constraint in your JSON schema that failed validation.

", + "InvalidConfigurationDetail$Location": "

Location of the validation constraint in the configuration JSON schema that failed validation.

", + "InvalidConfigurationDetail$Reason": "

The reason for an invalid configuration error.

", + "InvalidConfigurationDetail$Type": "

The type of error for an invalid configuration.

", "PayloadTooLargeException$Message": null, "ResourceNotFoundException$Message": null, "ResourceNotFoundException$ResourceName": null, @@ -635,15 +671,21 @@ "StringWithLengthBetween0And32768": { "base": null, "refs": { - "Validator$Content": "

Either the JSON Schema content or the Amazon Resource Name (ARN) of an AWS Lambda function.

" + "Validator$Content": "

Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.

" + } + }, + "StringWithLengthBetween1And2048": { + "base": null, + "refs": { + "Monitor$AlarmArn": "

Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.

" } }, "StringWithLengthBetween1And255": { "base": null, "refs": { - "CreateHostedConfigurationVersionRequest$ContentType": "

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

", - "HostedConfigurationVersion$ContentType": "

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

", - "HostedConfigurationVersionSummary$ContentType": "

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

" + "CreateHostedConfigurationVersionRequest$ContentType": "

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

", + "HostedConfigurationVersion$ContentType": "

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

", + "HostedConfigurationVersionSummary$ContentType": "

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

" } }, "StringWithLengthBetween1And64": { @@ -652,7 +694,7 @@ "GetConfigurationRequest$Application": "

The application to get. Specify either the application name or the application ID.

", "GetConfigurationRequest$Environment": "

The environment to get. Specify either the environment name or the environment ID.

", "GetConfigurationRequest$Configuration": "

The configuration to get. Specify either the configuration name or the configuration ID.

", - "GetConfigurationRequest$ClientId": "

A unique ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.

" + "GetConfigurationRequest$ClientId": "

The clientId parameter in the following command is a unique, user-specified ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.

" } }, "TagKey": { @@ -694,7 +736,7 @@ "TriggeredBy": { "base": null, "refs": { - "DeploymentEvent$TriggeredBy": "

The entity that triggered the deployment event. Events can be triggered by a user, AWS AppConfig, an Amazon CloudWatch alarm, or an internal error.

" + "DeploymentEvent$TriggeredBy": "

The entity that triggered the deployment event. Events can be triggered by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.

" } }, "UntagResourceRequest": { @@ -727,7 +769,7 @@ "refs": { "ConfigurationProfile$LocationUri": "

The URI location of the configuration.

", "ConfigurationProfileSummary$LocationUri": "

The URI location of the configuration.

", - "CreateConfigurationProfileRequest$LocationUri": "

A URI to locate the configuration. You can specify a Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the Amazon Resource Name (ARN). For a parameter, specify either the parameter name in the format ssm-parameter://<Parameter_name> or the ARN. For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/<objectKey> . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json

", + "CreateConfigurationProfileRequest$LocationUri": "

A URI to locate the configuration. You can specify the AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store and for feature flags, specify hosted. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the Amazon Resource Name (ARN). For a parameter, specify either the parameter name in the format ssm-parameter://<Parameter_name> or the ARN. For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/<objectKey> . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json

", "Deployment$ConfigurationLocationUri": "

Information about the source location of the configuration.

" } }, @@ -737,7 +779,7 @@ } }, "Validator": { - "base": "

A validator provides a syntactic or semantic check to ensure the configuration you want to deploy functions as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.

", + "base": "

A validator provides a syntactic or semantic check to ensure the configuration that you want to deploy functions as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.

", "refs": { "ValidatorList$member": null } @@ -769,7 +811,7 @@ "Configuration$ConfigurationVersion": "

The configuration version.

", "Deployment$ConfigurationVersion": "

The configuration version that was deployed.

", "DeploymentSummary$ConfigurationVersion": "

The version of the configuration.

", - "GetConfigurationRequest$ClientConfigurationVersion": "

The configuration version returned in the most recent GetConfiguration response.

AWS AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration.

To avoid excess charges, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.

For more information about working with configurations, see Retrieving the Configuration in the AWS AppConfig User Guide.

", + "GetConfigurationRequest$ClientConfigurationVersion": "

The configuration version returned in the most recent GetConfiguration response.

AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration.

To avoid excess charges, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.

For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.

", "StartDeploymentRequest$ConfigurationVersion": "

The configuration version to deploy.

", "ValidateConfigurationRequest$ConfigurationVersion": "

The version of the configuration to validate.

" } diff --git a/models/apis/appconfig/2019-10-09/examples-1.json b/models/apis/appconfig/2019-10-09/examples-1.json index 0ea7e3b0bb..664e05eff0 100644 --- a/models/apis/appconfig/2019-10-09/examples-1.json +++ b/models/apis/appconfig/2019-10-09/examples-1.json @@ -1,5 +1,720 @@ { "version": "1.0", "examples": { + "CreateApplication": [ + { + "input": { + "Description": "An application used for creating an example.", + "Name": "example-application" + }, + "output": { + "Description": "An application used for creating an example.", + "Id": "339ohji", + "Name": "example-application" + }, + "comments": { + }, + "description": "The following create-application example creates an application in AWS AppConfig.", + "id": "to-create-an-application-1632264511615", + "title": "To create an application" + } + ], + "CreateConfigurationProfile": [ + { + "input": { + "ApplicationId": "339ohji", + "LocationUri": "ssm-parameter://Example-Parameter", + "Name": "Example-Configuration-Profile", + "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" + }, + "output": { + "ApplicationId": "339ohji", + "Id": "ur8hx2f", + "LocationUri": "ssm-parameter://Example-Parameter", + "Name": "Example-Configuration-Profile", + "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" + }, + "comments": { + }, + "description": "The following create-configuration-profile example creates a configuration profile using a configuration stored in Parameter Store, a capability of Systems Manager.", + "id": "to-create-a-configuration-profile-1632264580336", + "title": "To create a configuration profile" + } + ], + "CreateDeploymentStrategy": [ + { + "input": { + "DeploymentDurationInMinutes": 15, + "GrowthFactor": 25, + "Name": "Example-Deployment", + "ReplicateTo": "SSM_DOCUMENT" + }, + "output": { + "DeploymentDurationInMinutes": 15, + "FinalBakeTimeInMinutes": 0, + "GrowthFactor": 25, + "GrowthType": "LINEAR", + "Id": "1225qzk", + "Name": "Example-Deployment", + "ReplicateTo": "SSM_DOCUMENT" + }, + "comments": { + }, + "description": "The following create-deployment-strategy example creates a deployment strategy called Example-Deployment that takes 15 minutes and deploys the configuration to 25% of the application at a time. The strategy is also copied to an SSM Document.", + "id": "to-create-a-deployment-strategy-1632264783812", + "title": "To create a deployment strategy" + } + ], + "CreateEnvironment": [ + { + "input": { + "ApplicationId": "339ohji", + "Name": "Example-Environment" + }, + "output": { + "ApplicationId": "339ohji", + "Id": "54j1r29", + "Name": "Example-Environment", + "State": "READY_FOR_DEPLOYMENT" + }, + "comments": { + }, + "description": "The following create-environment example creates an AWS AppConfig environment named Example-Environment using the application you created using create-application", + "id": "to-create-an-environment-1632265124975", + "title": "To create an environment" + } + ], + "CreateHostedConfigurationVersion": [ + { + "input": { + "ApplicationId": "339ohji", + "ConfigurationProfileId": "ur8hx2f", + "Content": "eyAiTmFtZSI6ICJFeGFtcGxlQXBwbGljYXRpb24iLCAiSWQiOiBFeGFtcGxlSUQsICJSYW5rIjogNyB9", + "ContentType": "text", + "LatestVersionNumber": 1 + }, + "output": { + "ApplicationId": "339ohji", + "ConfigurationProfileId": "ur8hx2f", + "ContentType": "text", + "VersionNumber": 1 + }, + "comments": { + }, + "description": "The following create-hosted-configuration-version example creates a new configuration in the AWS AppConfig configuration store.", + "id": "to-create-a-hosted-configuration-version-1632265196980", + "title": "To create a hosted configuration version" + } + ], + "DeleteApplication": [ + { + "input": { + "ApplicationId": "339ohji" + }, + "comments": { + }, + "description": "The following delete-application example deletes the specified application. \n", + "id": "to-delete-an-application-1632265343951", + "title": "To delete an application" + } + ], + "DeleteConfigurationProfile": [ + { + "input": { + "ApplicationId": "339ohji", + "ConfigurationProfileId": "ur8hx2f" + }, + "comments": { + }, + "description": "The following delete-configuration-profile example deletes the specified configuration profile.", + "id": "to-delete-a-configuration-profile-1632265401308", + "title": "To delete a configuration profile" + } + ], + "DeleteDeploymentStrategy": [ + { + "input": { + "DeploymentStrategyId": "1225qzk" + }, + "comments": { + }, + "description": "The following delete-deployment-strategy example deletes the specified deployment strategy.", + "id": "to-delete-a-deployment-strategy-1632265473708", + "title": "To delete a deployment strategy" + } + ], + "DeleteEnvironment": [ + { + "input": { + "ApplicationId": "339ohji", + "EnvironmentId": "54j1r29" + }, + "comments": { + }, + "description": "The following delete-environment example deletes the specified application environment.", + "id": "to-delete-an-environment-1632265641044", + "title": "To delete an environment" + } + ], + "DeleteHostedConfigurationVersion": [ + { + "input": { + "ApplicationId": "339ohji", + "ConfigurationProfileId": "ur8hx2f", + "VersionNumber": 1 + }, + "comments": { + }, + "description": "The following delete-hosted-configuration-version example deletes a configuration version hosted in the AWS AppConfig configuration store.", + "id": "to-delete-a-hosted-configuration-version-1632265720740", + "title": "To delete a hosted configuration version" + } + ], + "GetApplication": [ + { + "input": { + "ApplicationId": "339ohji" + }, + "output": { + "Id": "339ohji", + "Name": "example-application" + }, + "comments": { + }, + "description": "The following get-application example lists the details of the specified application.", + "id": "to-list-details-of-an-application-1632265864702", + "title": "To list details of an application" + } + ], + "GetConfiguration": [ + { + "input": { + "Application": "example-application", + "ClientId": "example-id", + "Configuration": "Example-Configuration-Profile", + "Environment": "Example-Environment" + }, + "output": { + "ConfigurationVersion": "1", + "ContentType": "application/octet-stream" + }, + "comments": { + }, + "description": "The following get-configuration example returns the configuration details of the example application. On subsequent calls to get-configuration, use the client-configuration-version parameter to only update the configuration of your application if the version has changed. Only updating the configuration when the version has changed avoids excess charges incurred by calling get-configuration.", + "id": "to-retrieve-configuration-details-1632265954314", + "title": "To retrieve configuration details" + } + ], + "GetConfigurationProfile": [ + { + "input": { + "ApplicationId": "339ohji", + "ConfigurationProfileId": "ur8hx2f" + }, + "output": { + "ApplicationId": "339ohji", + "Id": "ur8hx2f", + "LocationUri": "ssm-parameter://Example-Parameter", + "Name": "Example-Configuration-Profile", + "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" + }, + "comments": { + }, + "description": "The following get-configuration-profile example returns the details of the specified configuration profile.", + "id": "to-retrieve-configuration-profile-details-1632266081013", + "title": "To retrieve configuration profile details" + } + ], + "GetDeployment": [ + { + "input": { + "ApplicationId": "339ohji", + "DeploymentNumber": 1, + "EnvironmentId": "54j1r29" + }, + "output": { + "ApplicationId": "339ohji", + "CompletedAt": "2021-09-17T21:59:03.888000+00:00", + "ConfigurationLocationUri": "ssm-parameter://Example-Parameter", + "ConfigurationName": "Example-Configuration-Profile", + "ConfigurationProfileId": "ur8hx2f", + "ConfigurationVersion": "1", + "DeploymentDurationInMinutes": 15, + "DeploymentNumber": 1, + "DeploymentStrategyId": "1225qzk", + "EnvironmentId": "54j1r29", + "EventLog": [ + { + "Description": "Deployment completed", + "EventType": "DEPLOYMENT_COMPLETED", + "OccurredAt": "2021-09-17T21:59:03.888000+00:00", + "TriggeredBy": "APPCONFIG" + }, + { + "Description": "Deployment bake time started", + "EventType": "BAKE_TIME_STARTED", + "OccurredAt": "2021-09-17T21:58:57.722000+00:00", + "TriggeredBy": "APPCONFIG" + }, + { + "Description": "Configuration available to 100.00% of clients", + "EventType": "PERCENTAGE_UPDATED", + "OccurredAt": "2021-09-17T21:55:56.816000+00:00", + "TriggeredBy": "APPCONFIG" + }, + { + "Description": "Configuration available to 75.00% of clients", + "EventType": "PERCENTAGE_UPDATED", + "OccurredAt": "2021-09-17T21:52:56.567000+00:00", + "TriggeredBy": "APPCONFIG" + }, + { + "Description": "Configuration available to 50.00% of clients", + "EventType": "PERCENTAGE_UPDATED", + "OccurredAt": "2021-09-17T21:49:55.737000+00:00", + "TriggeredBy": "APPCONFIG" + }, + { + "Description": "Configuration available to 25.00% of clients", + "EventType": "PERCENTAGE_UPDATED", + "OccurredAt": "2021-09-17T21:46:55.187000+00:00", + "TriggeredBy": "APPCONFIG" + }, + { + "Description": "Deployment started", + "EventType": "DEPLOYMENT_STARTED", + "OccurredAt": "2021-09-17T21:43:54.205000+00:00", + "TriggeredBy": "USER" + } + ], + "FinalBakeTimeInMinutes": 0, + "GrowthFactor": 25, + "GrowthType": "LINEAR", + "PercentageComplete": 100, + "StartedAt": "2021-09-17T21:43:54.205000+00:00", + "State": "COMPLETE" + }, + "comments": { + }, + "description": "The following get-deployment example lists details of the deployment to the application in the specified environment and deployment.", + "id": "to-retrieve-deployment-details-1633976766883", + "title": "To retrieve deployment details" + } + ], + "GetDeploymentStrategy": [ + { + "input": { + "DeploymentStrategyId": "1225qzk" + }, + "output": { + "DeploymentDurationInMinutes": 15, + "FinalBakeTimeInMinutes": 0, + "GrowthFactor": 25, + "GrowthType": "LINEAR", + "Id": "1225qzk", + "Name": "Example-Deployment", + "ReplicateTo": "SSM_DOCUMENT" + }, + "comments": { + }, + "description": "The following get-deployment-strategy example lists the details of the specified deployment strategy.", + "id": "to-retrieve-details-of-a-deployment-strategy-1632266385805", + "title": "To retrieve details of a deployment strategy" + } + ], + "GetEnvironment": [ + { + "input": { + "ApplicationId": "339ohji", + "EnvironmentId": "54j1r29" + }, + "output": { + "ApplicationId": "339ohji", + "Id": "54j1r29", + "Name": "Example-Environment", + "State": "READY_FOR_DEPLOYMENT" + }, + "comments": { + }, + "description": "The following get-environment example returns the details and state of the specified environment.", + "id": "to-retrieve-environment-details-1632266924806", + "title": "To retrieve environment details" + } + ], + "GetHostedConfigurationVersion": [ + { + "input": { + "ApplicationId": "339ohji", + "ConfigurationProfileId": "ur8hx2f", + "VersionNumber": 1 + }, + "output": { + "ApplicationId": "339ohji", + "ConfigurationProfileId": "ur8hx2f", + "ContentType": "application/json", + "VersionNumber": 1 + }, + "comments": { + }, + "description": "The following get-hosted-configuration-version example retrieves the configuration details of the AWS AppConfig hosted configuration.", + "id": "to-retrieve-hosted-configuration-details-1632267003527", + "title": "To retrieve hosted configuration details" + } + ], + "ListApplications": [ + { + "input": { + }, + "output": { + "Items": [ + { + "Description": "An application used for creating an example.", + "Id": "339ohji", + "Name": "test-application" + }, + { + "Id": "rwalwu7", + "Name": "Test-Application" + } + ] + }, + "comments": { + }, + "description": "The following list-applications example lists the available applications in your AWS account.", + "id": "to-list-the-available-applications-1632267111131", + "title": "To list the available applications" + } + ], + "ListConfigurationProfiles": [ + { + "input": { + "ApplicationId": "339ohji" + }, + "output": { + "Items": [ + { + "ApplicationId": "339ohji", + "Id": "ur8hx2f", + "LocationUri": "ssm-parameter://Example-Parameter", + "Name": "Example-Configuration-Profile" + } + ] + }, + "comments": { + }, + "description": "The following list-configuration-profiles example lists the available configuration profiles for the specified application.", + "id": "to-list-the-available-configuration-profiles-1632267193265", + "title": "To list the available configuration profiles" + } + ], + "ListDeploymentStrategies": [ + { + "input": { + }, + "output": { + "Items": [ + { + "DeploymentDurationInMinutes": 15, + "FinalBakeTimeInMinutes": 0, + "GrowthFactor": 25, + "GrowthType": "LINEAR", + "Id": "1225qzk", + "Name": "Example-Deployment", + "ReplicateTo": "SSM_DOCUMENT" + } + ] + }, + "comments": { + }, + "description": "The following list-deployment-strategies example lists the available deployment strategies in your AWS account.", + "id": "to-list-the-available-deployment-strategies-1632267364180", + "title": "To list the available deployment strategies" + } + ], + "ListDeployments": [ + { + "input": { + "ApplicationId": "339ohji", + "EnvironmentId": "54j1r29" + }, + "output": { + "Items": [ + { + "CompletedAt": "2021-09-17T21:59:03.888000+00:00", + "ConfigurationName": "Example-Configuration-Profile", + "ConfigurationVersion": "1", + "DeploymentDurationInMinutes": 15, + "DeploymentNumber": 1, + "FinalBakeTimeInMinutes": 0, + "GrowthFactor": 25, + "GrowthType": "LINEAR", + "PercentageComplete": 100, + "StartedAt": "2021-09-17T21:43:54.205000+00:00", + "State": "COMPLETE" + } + ] + }, + "comments": { + }, + "description": "The following list-deployments example lists the available deployments in your AWS account for the specified application and environment.", + "id": "to-list-the-available-deployments-1632267282025", + "title": "To list the available deployments" + } + ], + "ListEnvironments": [ + { + "input": { + "ApplicationId": "339ohji" + }, + "output": { + "Items": [ + { + "ApplicationId": "339ohji", + "Id": "54j1r29", + "Name": "Example-Environment", + "State": "READY_FOR_DEPLOYMENT" + } + ] + }, + "comments": { + }, + "description": "The following list-environments example lists the available environments in your AWS account for the specified application.", + "id": "to-list-the-available-environments-1632267474389", + "title": "To list the available environments" + } + ], + "ListHostedConfigurationVersions": [ + { + "input": { + "ApplicationId": "339ohji", + "ConfigurationProfileId": "ur8hx2f" + }, + "output": { + "Items": [ + { + "ApplicationId": "339ohji", + "ConfigurationProfileId": "ur8hx2f", + "ContentType": "application/json", + "VersionNumber": 1 + } + ] + }, + "comments": { + }, + "description": "The following list-hosted-configuration-versions example lists the configurations versions hosted in the AWS AppConfig hosted configuration store for the specified application and configuration profile.", + "id": "to-list-the-available-hosted-configuration-versions-1632267647667", + "title": "To list the available hosted configuration versions" + } + ], + "ListTagsForResource": [ + { + "input": { + "ResourceArn": "arn:aws:appconfig:us-east-1:111122223333:application/339ohji" + }, + "output": { + "Tags": { + "group1": "1" + } + }, + "comments": { + }, + "description": "The following list-tags-for-resource example lists the tags of a specified application.", + "id": "to-list-the-tags-of-an-application-1632328796560", + "title": "To list the tags of an application" + } + ], + "StartDeployment": [ + { + "input": { + "ApplicationId": "339ohji", + "ConfigurationProfileId": "ur8hx2f", + "ConfigurationVersion": "1", + "DeploymentStrategyId": "1225qzk", + "Description": "", + "EnvironmentId": "54j1r29", + "Tags": { + } + }, + "output": { + "ApplicationId": "339ohji", + "ConfigurationLocationUri": "ssm-parameter://Example-Parameter", + "ConfigurationName": "Example-Configuration-Profile", + "ConfigurationProfileId": "ur8hx2f", + "ConfigurationVersion": "1", + "DeploymentDurationInMinutes": 15, + "DeploymentNumber": 1, + "DeploymentStrategyId": "1225qzk", + "EnvironmentId": "54j1r29", + "EventLog": [ + { + "Description": "Deployment started", + "EventType": "DEPLOYMENT_STARTED", + "OccurredAt": "2021-09-17T21:43:54.205000+00:00", + "TriggeredBy": "USER" + } + ], + "FinalBakeTimeInMinutes": 0, + "GrowthFactor": 25, + "GrowthType": "LINEAR", + "PercentageComplete": 1.0, + "StartedAt": "2021-09-17T21:43:54.205000+00:00", + "State": "DEPLOYING" + }, + "comments": { + }, + "description": "The following start-deployment example starts a deployment to the application using the specified environment, deployment strategy, and configuration profile.", + "id": "to-start-a-configuration-deployment-1632328956790", + "title": "To start a configuration deployment" + } + ], + "StopDeployment": [ + { + "input": { + "ApplicationId": "339ohji", + "DeploymentNumber": 2, + "EnvironmentId": "54j1r29" + }, + "output": { + "DeploymentDurationInMinutes": 15, + "DeploymentNumber": 2, + "FinalBakeTimeInMinutes": 0, + "GrowthFactor": 25.0, + "PercentageComplete": 1.0 + }, + "comments": { + }, + "description": "The following stop-deployment example stops the deployment of an application configuration to the specified environment.", + "id": "to-stop-configuration-deployment-1632329139126", + "title": "To stop configuration deployment" + } + ], + "TagResource": [ + { + "input": { + "ResourceArn": "arn:aws:appconfig:us-east-1:111122223333:application/339ohji", + "Tags": { + "group1": "1" + } + }, + "comments": { + }, + "description": "The following tag-resource example tags an application resource.", + "id": "to-tag-an-application-1632330350645", + "title": "To tag an application" + } + ], + "UntagResource": [ + { + "input": { + "ResourceArn": "arn:aws:appconfig:us-east-1:111122223333:application/339ohji", + "TagKeys": [ + "group1" + ] + }, + "comments": { + }, + "description": "The following untag-resource example removes the group1 tag from the specified application.", + "id": "to-remove-a-tag-from-an-application-1632330429881", + "title": "To remove a tag from an application" + } + ], + "UpdateApplication": [ + { + "input": { + "ApplicationId": "339ohji", + "Description": "", + "Name": "Example-Application" + }, + "output": { + "Description": "An application used for creating an example.", + "Id": "339ohji", + "Name": "Example-Application" + }, + "comments": { + }, + "description": "The following update-application example updates the name of the specified application.", + "id": "to-update-an-application-1632330585893", + "title": "To update an application" + } + ], + "UpdateConfigurationProfile": [ + { + "input": { + "ApplicationId": "339ohji", + "ConfigurationProfileId": "ur8hx2f", + "Description": "Configuration profile used for examples." + }, + "output": { + "ApplicationId": "339ohji", + "Description": "Configuration profile used for examples.", + "Id": "ur8hx2f", + "LocationUri": "ssm-parameter://Example-Parameter", + "Name": "Example-Configuration-Profile", + "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" + }, + "comments": { + }, + "description": "The following update-configuration-profile example updates the description of the specified configuration profile.", + "id": "to-update-a-configuration-profile-1632330721974", + "title": "To update a configuration profile" + } + ], + "UpdateDeploymentStrategy": [ + { + "input": { + "DeploymentStrategyId": "1225qzk", + "FinalBakeTimeInMinutes": 20 + }, + "output": { + "DeploymentDurationInMinutes": 15, + "FinalBakeTimeInMinutes": 20, + "GrowthFactor": 25, + "GrowthType": "LINEAR", + "Id": "1225qzk", + "Name": "Example-Deployment", + "ReplicateTo": "SSM_DOCUMENT" + }, + "comments": { + }, + "description": "The following update-deployment-strategy example updates final bake time to 20 minutes in the specified deployment strategy. ::\n", + "id": "to-update-a-deployment-strategy-1632330896602", + "title": "To update a deployment strategy" + } + ], + "UpdateEnvironment": [ + { + "input": { + "ApplicationId": "339ohji", + "Description": "An environment for examples.", + "EnvironmentId": "54j1r29" + }, + "output": { + "ApplicationId": "339ohji", + "Description": "An environment for examples.", + "Id": "54j1r29", + "Name": "Example-Environment", + "State": "ROLLED_BACK" + }, + "comments": { + }, + "description": "The following update-environment example updates an environment's description.", + "id": "to-update-an-environment-1632331382428", + "title": "To update an environment" + } + ], + "ValidateConfiguration": [ + { + "input": { + "ApplicationId": "abc1234", + "ConfigurationProfileId": "ur8hx2f", + "ConfigurationVersion": "1" + }, + "comments": { + }, + "description": "The following validate-configuration example uses the validators in a configuration profile to validate a configuration.", + "id": "to-validate-a-configuration-1632331491365", + "title": "To validate a configuration" + } + ] } } diff --git a/models/apis/auditmanager/2017-07-25/api-2.json b/models/apis/auditmanager/2017-07-25/api-2.json index cd88bf2e94..a373b0312e 100644 --- a/models/apis/auditmanager/2017-07-25/api-2.json +++ b/models/apis/auditmanager/2017-07-25/api-2.json @@ -458,6 +458,34 @@ {"shape":"InternalServerException"} ] }, + "GetInsights":{ + "name":"GetInsights", + "http":{ + "method":"GET", + "requestUri":"/insights" + }, + "input":{"shape":"GetInsightsRequest"}, + "output":{"shape":"GetInsightsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, + "GetInsightsByAssessment":{ + "name":"GetInsightsByAssessment", + "http":{ + "method":"GET", + "requestUri":"/insights/assessments/{assessmentId}" + }, + "input":{"shape":"GetInsightsByAssessmentRequest"}, + "output":{"shape":"GetInsightsByAssessmentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, "GetOrganizationAdminAccount":{ "name":"GetOrganizationAdminAccount", "http":{ @@ -500,6 +528,21 @@ {"shape":"InternalServerException"} ] }, + "ListAssessmentControlInsightsByControlDomain":{ + "name":"ListAssessmentControlInsightsByControlDomain", + "http":{ + "method":"GET", + "requestUri":"/insights/controls-by-assessment" + }, + "input":{"shape":"ListAssessmentControlInsightsByControlDomainRequest"}, + "output":{"shape":"ListAssessmentControlInsightsByControlDomainResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, "ListAssessmentFrameworkShareRequests":{ "name":"ListAssessmentFrameworkShareRequests", "http":{ @@ -556,6 +599,51 @@ {"shape":"InternalServerException"} ] }, + "ListControlDomainInsights":{ + "name":"ListControlDomainInsights", + "http":{ + "method":"GET", + "requestUri":"/insights/control-domains" + }, + "input":{"shape":"ListControlDomainInsightsRequest"}, + "output":{"shape":"ListControlDomainInsightsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ] + }, + "ListControlDomainInsightsByAssessment":{ + "name":"ListControlDomainInsightsByAssessment", + "http":{ + "method":"GET", + "requestUri":"/insights/control-domains-by-assessment" + }, + "input":{"shape":"ListControlDomainInsightsByAssessmentRequest"}, + "output":{"shape":"ListControlDomainInsightsByAssessmentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, + "ListControlInsightsByControlDomain":{ + "name":"ListControlInsightsByControlDomain", + "http":{ + "method":"GET", + "requestUri":"/insights/controls" + }, + "input":{"shape":"ListControlInsightsByControlDomainRequest"}, + "output":{"shape":"ListControlInsightsByControlDomainResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ] + }, "ListControls":{ "name":"ListControls", "http":{ @@ -1402,6 +1490,48 @@ "max":1000, "pattern":"^[\\w\\W\\s\\S]*$" }, + "ControlDomainInsights":{ + "type":"structure", + "members":{ + "name":{"shape":"NonEmptyString"}, + "id":{"shape":"UUID"}, + "controlsCountByNoncompliantEvidence":{"shape":"NullableInteger"}, + "totalControlsCount":{"shape":"NullableInteger"}, + "evidenceInsights":{"shape":"EvidenceInsights"}, + "lastUpdated":{"shape":"Timestamp"} + } + }, + "ControlDomainInsightsList":{ + "type":"list", + "member":{"shape":"ControlDomainInsights"} + }, + "ControlInsightsMetadata":{ + "type":"list", + "member":{"shape":"ControlInsightsMetadataItem"} + }, + "ControlInsightsMetadataByAssessment":{ + "type":"list", + "member":{"shape":"ControlInsightsMetadataByAssessmentItem"} + }, + "ControlInsightsMetadataByAssessmentItem":{ + "type":"structure", + "members":{ + "name":{"shape":"NonEmptyString"}, + "id":{"shape":"UUID"}, + "evidenceInsights":{"shape":"EvidenceInsights"}, + "controlSetName":{"shape":"NonEmptyString"}, + "lastUpdated":{"shape":"Timestamp"} + } + }, + "ControlInsightsMetadataItem":{ + "type":"structure", + "members":{ + "name":{"shape":"NonEmptyString"}, + "id":{"shape":"UUID"}, + "evidenceInsights":{"shape":"EvidenceInsights"}, + "lastUpdated":{"shape":"Timestamp"} + } + }, "ControlMappingSource":{ "type":"structure", "members":{ @@ -1918,6 +2048,14 @@ "max":50, "min":0 }, + "EvidenceInsights":{ + "type":"structure", + "members":{ + "noncompliantEvidenceCount":{"shape":"NullableInteger"}, + "compliantEvidenceCount":{"shape":"NullableInteger"}, + "inconclusiveEvidenceCount":{"shape":"NullableInteger"} + } + }, "EvidenceList":{ "type":"list", "member":{"shape":"Evidence"} @@ -2317,6 +2455,34 @@ "evidence":{"shape":"Evidence"} } }, + "GetInsightsByAssessmentRequest":{ + "type":"structure", + "required":["assessmentId"], + "members":{ + "assessmentId":{ + "shape":"UUID", + "location":"uri", + "locationName":"assessmentId" + } + } + }, + "GetInsightsByAssessmentResponse":{ + "type":"structure", + "members":{ + "insights":{"shape":"InsightsByAssessment"} + } + }, + "GetInsightsRequest":{ + "type":"structure", + "members":{ + } + }, + "GetInsightsResponse":{ + "type":"structure", + "members":{ + "insights":{"shape":"Insights"} + } + }, "GetOrganizationAdminAccountRequest":{ "type":"structure", "members":{ @@ -2369,6 +2535,29 @@ "min":20, "pattern":"^arn:.*:iam:.*" }, + "Insights":{ + "type":"structure", + "members":{ + "activeAssessmentsCount":{"shape":"NullableInteger"}, + "noncompliantEvidenceCount":{"shape":"NullableInteger"}, + "compliantEvidenceCount":{"shape":"NullableInteger"}, + "inconclusiveEvidenceCount":{"shape":"NullableInteger"}, + "assessmentControlsCountByNoncompliantEvidence":{"shape":"NullableInteger"}, + "totalAssessmentControlsCount":{"shape":"NullableInteger"}, + "lastUpdated":{"shape":"Timestamp"} + } + }, + "InsightsByAssessment":{ + "type":"structure", + "members":{ + "noncompliantEvidenceCount":{"shape":"NullableInteger"}, + "compliantEvidenceCount":{"shape":"NullableInteger"}, + "inconclusiveEvidenceCount":{"shape":"NullableInteger"}, + "assessmentControlsCountByNoncompliantEvidence":{"shape":"NullableInteger"}, + "totalAssessmentControlsCount":{"shape":"NullableInteger"}, + "lastUpdated":{"shape":"Timestamp"} + } + }, "Integer":{"type":"integer"}, "InternalServerException":{ "type":"structure", @@ -2406,6 +2595,42 @@ "min":1, "pattern":"^[a-zA-Z0-9\\s-_()\\[\\]]+$" }, + "ListAssessmentControlInsightsByControlDomainRequest":{ + "type":"structure", + "required":[ + "controlDomainId", + "assessmentId" + ], + "members":{ + "controlDomainId":{ + "shape":"UUID", + "location":"querystring", + "locationName":"controlDomainId" + }, + "assessmentId":{ + "shape":"UUID", + "location":"querystring", + "locationName":"assessmentId" + }, + "nextToken":{ + "shape":"Token", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListAssessmentControlInsightsByControlDomainResponse":{ + "type":"structure", + "members":{ + "controlInsightsByAssessment":{"shape":"ControlInsightsMetadataByAssessment"}, + "nextToken":{"shape":"Token"} + } + }, "ListAssessmentFrameworkShareRequestsRequest":{ "type":"structure", "required":["requestType"], @@ -2491,6 +2716,11 @@ "ListAssessmentsRequest":{ "type":"structure", "members":{ + "status":{ + "shape":"AssessmentStatus", + "location":"querystring", + "locationName":"status" + }, "nextToken":{ "shape":"Token", "location":"querystring", @@ -2510,6 +2740,84 @@ "nextToken":{"shape":"Token"} } }, + "ListControlDomainInsightsByAssessmentRequest":{ + "type":"structure", + "required":["assessmentId"], + "members":{ + "assessmentId":{ + "shape":"UUID", + "location":"querystring", + "locationName":"assessmentId" + }, + "nextToken":{ + "shape":"Token", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListControlDomainInsightsByAssessmentResponse":{ + "type":"structure", + "members":{ + "controlDomainInsights":{"shape":"ControlDomainInsightsList"}, + "nextToken":{"shape":"Token"} + } + }, + "ListControlDomainInsightsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"Token", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListControlDomainInsightsResponse":{ + "type":"structure", + "members":{ + "controlDomainInsights":{"shape":"ControlDomainInsightsList"}, + "nextToken":{"shape":"Token"} + } + }, + "ListControlInsightsByControlDomainRequest":{ + "type":"structure", + "required":["controlDomainId"], + "members":{ + "controlDomainId":{ + "shape":"UUID", + "location":"querystring", + "locationName":"controlDomainId" + }, + "nextToken":{ + "shape":"Token", + "location":"querystring", + "locationName":"nextToken" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListControlInsightsByControlDomainResponse":{ + "type":"structure", + "members":{ + "controlInsightsMetadata":{"shape":"ControlInsightsMetadata"}, + "nextToken":{"shape":"Token"} + } + }, "ListControlsRequest":{ "type":"structure", "required":["controlType"], diff --git a/models/apis/auditmanager/2017-07-25/docs-2.json b/models/apis/auditmanager/2017-07-25/docs-2.json index 77d456b276..e3d7bf3ee5 100644 --- a/models/apis/auditmanager/2017-07-25/docs-2.json +++ b/models/apis/auditmanager/2017-07-25/docs-2.json @@ -21,8 +21,8 @@ "DeregisterOrganizationAdminAccount": "

Removes the specified member Amazon Web Services account as a delegated administrator for Audit Manager.

When you remove a delegated administrator from your Audit Manager settings, you continue to have access to the evidence that you previously collected under that account. This is also the case when you deregister a delegated administrator from Audit Manager. However, Audit Manager will stop collecting and attaching evidence to that delegated administrator account moving forward.

", "DisassociateAssessmentReportEvidenceFolder": "

Disassociates an evidence folder from the specified assessment report in Audit Manager.

", "GetAccountStatus": "

Returns the registration status of an account in Audit Manager.

", - "GetAssessment": "

Returns an assessment from Audit Manager.

", - "GetAssessmentFramework": "

Returns a framework from Audit Manager.

", + "GetAssessment": "

Returns an assessment from Audit Manager.

", + "GetAssessmentFramework": "

Returns a framework from Audit Manager.

", "GetAssessmentReportUrl": "

Returns the URL of an assessment report in Audit Manager.

", "GetChangeLogs": "

Returns a list of changelogs from Audit Manager.

", "GetControl": "

Returns a control from Audit Manager.

", @@ -32,13 +32,19 @@ "GetEvidenceFolder": "

Returns an evidence folder from the specified assessment in Audit Manager.

", "GetEvidenceFoldersByAssessment": "

Returns the evidence folders from a specified assessment in Audit Manager.

", "GetEvidenceFoldersByAssessmentControl": "

Returns a list of evidence folders that are associated with a specified control of an assessment in Audit Manager.

", + "GetInsights": "

Gets the latest analytics data for all your current active assessments.

", + "GetInsightsByAssessment": "

Gets the latest analytics data for a specific active assessment.

", "GetOrganizationAdminAccount": "

Returns the name of the delegated Amazon Web Services administrator account for the organization.

", "GetServicesInScope": "

Returns a list of the in-scope Amazon Web Services services for the specified assessment.

", "GetSettings": "

Returns the settings for the specified Amazon Web Services account.

", + "ListAssessmentControlInsightsByControlDomain": "

Lists the latest analytics data for controls within a specific control domain and a specific active assessment.

Control insights are listed only if the control belongs to the control domain and assessment that was specified. Moreover, the control must have collected evidence on the lastUpdated date of controlInsightsByAssessment. If neither of these conditions are met, no data is listed for that control.

", "ListAssessmentFrameworkShareRequests": "

Returns a list of sent or received share requests for custom frameworks in Audit Manager.

", "ListAssessmentFrameworks": "

Returns a list of the frameworks that are available in the Audit Manager framework library.

", "ListAssessmentReports": "

Returns a list of assessment reports created in Audit Manager.

", "ListAssessments": "

Returns a list of current and past assessments from Audit Manager.

", + "ListControlDomainInsights": "

Lists the latest analytics data for control domains across all of your active assessments.

A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that control domain.

", + "ListControlDomainInsightsByAssessment": "

Lists analytics data for control domains within a specified active assessment.

A control domain is listed only if at least one of the controls within that domain collected evidence on the lastUpdated date of controlDomainInsights. If this condition isn’t met, no data is listed for that domain.

", + "ListControlInsightsByControlDomain": "

Lists the latest analytics data for controls within a specific control domain across all active assessments.

Control insights are listed only if the control belongs to the control domain that was specified and the control collected evidence on the lastUpdated date of controlInsightsMetadata. If neither of these conditions are met, no data is listed for that control.

", "ListControls": "

Returns a list of controls from Audit Manager.

", "ListKeywordsForDataSource": "

Returns a list of keywords that are pre-mapped to the specified control data source.

", "ListNotifications": "

Returns a list of all Audit Manager notifications.

", @@ -347,6 +353,7 @@ "refs": { "AssessmentMetadata$status": "

The overall status of the assessment.

", "AssessmentMetadataItem$status": "

The current status of the assessment.

", + "ListAssessmentsRequest$status": "

The current status of the assessment.

", "UpdateAssessmentStatusRequest$status": "

The current status of the assessment.

" } }, @@ -476,7 +483,7 @@ "ChangeLogs": { "base": null, "refs": { - "GetChangeLogsResponse$changeLogs": "

The list of user activity for the control.

" + "GetChangeLogsResponse$changeLogs": "

The list of user activity for the control.

" } }, "ComplianceType": { @@ -529,6 +536,43 @@ "UpdateControlRequest$description": "

The optional description of the control.

" } }, + "ControlDomainInsights": { + "base": "

A summary of the latest analytics data for a specific control domain.

Control domain insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.

", + "refs": { + "ControlDomainInsightsList$member": null + } + }, + "ControlDomainInsightsList": { + "base": null, + "refs": { + "ListControlDomainInsightsByAssessmentResponse$controlDomainInsights": "

The control domain analytics data that the ListControlDomainInsightsByAssessment API returned.

", + "ListControlDomainInsightsResponse$controlDomainInsights": "

The control domain analytics data that the ListControlDomainInsights API returned.

" + } + }, + "ControlInsightsMetadata": { + "base": null, + "refs": { + "ListControlInsightsByControlDomainResponse$controlInsightsMetadata": "

The control analytics data that the ListControlInsightsByControlDomain API returned.

" + } + }, + "ControlInsightsMetadataByAssessment": { + "base": null, + "refs": { + "ListAssessmentControlInsightsByControlDomainResponse$controlInsightsByAssessment": "

The assessment control analytics data that the ListAssessmentControlInsightsByControlDomain API returned.

" + } + }, + "ControlInsightsMetadataByAssessmentItem": { + "base": "

A summary of the latest analytics data for a specific control in a specific active assessment.

Control insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.

", + "refs": { + "ControlInsightsMetadataByAssessment$member": null + } + }, + "ControlInsightsMetadataItem": { + "base": "

A summary of the latest analytics data for a specific control.

This data reflects the total counts for the specified control across all active assessments. Control insights are grouped by control domain, and ranked by the highest total count of non-compliant evidence.

", + "refs": { + "ControlInsightsMetadata$member": null + } + }, "ControlMappingSource": { "base": "

The data source that determines where Audit Manager collects evidence from for the control.

", "refs": { @@ -585,13 +629,13 @@ "BatchImportEvidenceToAssessmentControlRequest$controlSetId": "

The identifier for the control set.

", "CreateDelegationRequest$controlSetId": "

The unique identifier for the control set.

", "Delegation$controlSetId": "

The identifier for the control set that's associated with the delegation.

", - "GetChangeLogsRequest$controlSetId": "

The identifier for the control set.

", + "GetChangeLogsRequest$controlSetId": "

The unique identifier for the control set.

", "GetEvidenceByEvidenceFolderRequest$controlSetId": "

The identifier for the control set.

", - "GetEvidenceFolderRequest$controlSetId": "

The identifier for the control set.

", + "GetEvidenceFolderRequest$controlSetId": "

The unique identifier for the control set.

", "GetEvidenceFoldersByAssessmentControlRequest$controlSetId": "

The identifier for the control set.

", - "GetEvidenceRequest$controlSetId": "

The identifier for the control set.

", + "GetEvidenceRequest$controlSetId": "

The unique identifier for the control set.

", "Notification$controlSetId": "

The identifier for the control set.

", - "UpdateAssessmentControlRequest$controlSetId": "

The identifier for the control set.

" + "UpdateAssessmentControlRequest$controlSetId": "

The unique identifier for the control set.

" } }, "ControlSetName": { @@ -946,6 +990,14 @@ "BatchDisassociateAssessmentReportEvidenceResponse$evidenceIds": "

The identifier for the evidence.

" } }, + "EvidenceInsights": { + "base": "

A breakdown of the latest compliance check status for the evidence in your Audit Manager assessments.

", + "refs": { + "ControlDomainInsights$evidenceInsights": "

A breakdown of the compliance check status for the evidence that’s associated with the control domain.

", + "ControlInsightsMetadataByAssessmentItem$evidenceInsights": "

A breakdown of the compliance check status for the evidence that’s associated with the assessment control.

", + "ControlInsightsMetadataItem$evidenceInsights": "

A breakdown of the compliance check status for the evidence that’s associated with the control.

" + } + }, "EvidenceList": { "base": null, "refs": { @@ -1140,6 +1192,26 @@ "refs": { } }, + "GetInsightsByAssessmentRequest": { + "base": null, + "refs": { + } + }, + "GetInsightsByAssessmentResponse": { + "base": null, + "refs": { + } + }, + "GetInsightsRequest": { + "base": null, + "refs": { + } + }, + "GetInsightsResponse": { + "base": null, + "refs": { + } + }, "GetOrganizationAdminAccountRequest": { "base": null, "refs": { @@ -1187,6 +1259,18 @@ "Role$roleArn": "

The Amazon Resource Name (ARN) of the IAM role.

" } }, + "Insights": { + "base": "

A summary of the latest analytics data for all your active assessments.

This summary is a snapshot of the data that your active assessments collected on the lastUpdated date. It’s important to understand that the following totals are daily counts based on this date — they aren’t a total sum to date.

The Insights data is eventually consistent. This means that, when you read data from Insights, the response might not instantly reflect the results of a recently completed write or update operation. If you repeat your read request after a few hours, the response should return the latest data.

If you delete an assessment or change its status to inactive, InsightsByAssessment includes data for that assessment as follows.

", + "refs": { + "GetInsightsResponse$insights": "

The analytics data that the GetInsights API returned.

" + } + }, + "InsightsByAssessment": { + "base": "

A summary of the latest analytics data for a specific active assessment.

This summary is a snapshot of the data that was collected on the lastUpdated date. It’s important to understand that the totals in InsightsByAssessment are daily counts based on this date — they aren’t a total sum to date.

The InsightsByAssessment data is eventually consistent. This means that when you read data from InsightsByAssessment, the response might not instantly reflect the results of a recently completed write or update operation. If you repeat your read request after a few hours, the response returns the latest data.

If you delete an assessment or change its status to inactive, InsightsByAssessment includes data for that assessment as follows.

", + "refs": { + "GetInsightsByAssessmentResponse$insights": "

The assessment analytics data that the GetInsightsByAssessment API returned.

" + } + }, "Integer": { "base": null, "refs": { @@ -1244,6 +1328,16 @@ "Framework$lastUpdatedBy": "

The IAM user or role that most recently updated the framework.

" } }, + "ListAssessmentControlInsightsByControlDomainRequest": { + "base": null, + "refs": { + } + }, + "ListAssessmentControlInsightsByControlDomainResponse": { + "base": null, + "refs": { + } + }, "ListAssessmentFrameworkShareRequestsRequest": { "base": null, "refs": { @@ -1290,6 +1384,36 @@ "refs": { } }, + "ListControlDomainInsightsByAssessmentRequest": { + "base": null, + "refs": { + } + }, + "ListControlDomainInsightsByAssessmentResponse": { + "base": null, + "refs": { + } + }, + "ListControlDomainInsightsRequest": { + "base": null, + "refs": { + } + }, + "ListControlDomainInsightsResponse": { + "base": null, + "refs": { + } + }, + "ListControlInsightsByControlDomainRequest": { + "base": null, + "refs": { + } + }, + "ListControlInsightsByControlDomainResponse": { + "base": null, + "refs": { + } + }, "ListControlsRequest": { "base": null, "refs": { @@ -1346,15 +1470,19 @@ "MaxResults": { "base": "Max results in the page.", "refs": { - "GetChangeLogsRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", + "GetChangeLogsRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", "GetDelegationsRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", "GetEvidenceByEvidenceFolderRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", "GetEvidenceFoldersByAssessmentControlRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", "GetEvidenceFoldersByAssessmentRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", + "ListAssessmentControlInsightsByControlDomainRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", "ListAssessmentFrameworkShareRequestsRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", "ListAssessmentFrameworksRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", "ListAssessmentReportsRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", "ListAssessmentsRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", + "ListControlDomainInsightsByAssessmentRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", + "ListControlDomainInsightsRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", + "ListControlInsightsByControlDomainRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", "ListControlsRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", "ListKeywordsForDataSourceRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

", "ListNotificationsRequest$maxResults": "

Represents the maximum number of results on a page or for an API request call.

" @@ -1365,6 +1493,10 @@ "refs": { "AssessmentControlSet$description": "

The description for the control set.

", "ChangeLog$objectName": "

The name of the object that changed. This could be the name of an assessment, control, or control set.

", + "ControlDomainInsights$name": "

The name of the control domain.

", + "ControlInsightsMetadataByAssessmentItem$name": "

The name of the assessment control.

", + "ControlInsightsMetadataByAssessmentItem$controlSetName": "

The name of the control set that the assessment control belongs to.

", + "ControlInsightsMetadataItem$name": "

The name of the control.

", "DelegationMetadata$controlSetName": "

Specifies the name of the control set that was delegated for review.

", "EvidenceSources$member": null, "Notification$controlSetName": "

Specifies the name of the control set that the notification is about.

", @@ -1392,7 +1524,23 @@ "base": null, "refs": { "AssessmentFrameworkShareRequest$standardControlsCount": "

The number of standard controls that are part of the shared custom framework.

", - "AssessmentFrameworkShareRequest$customControlsCount": "

The number of custom controls that are part of the shared custom framework.

" + "AssessmentFrameworkShareRequest$customControlsCount": "

The number of custom controls that are part of the shared custom framework.

", + "ControlDomainInsights$controlsCountByNoncompliantEvidence": "

The number of controls in the control domain that collected non-compliant evidence on the lastUpdated date.

", + "ControlDomainInsights$totalControlsCount": "

The total number of controls in the control domain.

", + "EvidenceInsights$noncompliantEvidenceCount": "

The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

", + "EvidenceInsights$compliantEvidenceCount": "

The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

", + "EvidenceInsights$inconclusiveEvidenceCount": "

The number of evidence that a compliance check ruling isn't available for. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).

If evidence has a compliance check status of not applicable in the console, it's classified as inconclusive in EvidenceInsights data.

", + "Insights$activeAssessmentsCount": "

The number of active assessments in Audit Manager.

", + "Insights$noncompliantEvidenceCount": "

The number of compliance check evidence that Audit Manager classified as non-compliant on the lastUpdated date. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

", + "Insights$compliantEvidenceCount": "

The number of compliance check evidence that Audit Manager classified as compliant on the lastUpdated date. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

", + "Insights$inconclusiveEvidenceCount": "

The number of evidence without a compliance check ruling. Evidence is inconclusive when the associated control uses Security Hub or Config as a data source but you didn't enable those services. This is also the case when a control uses a data source that doesn’t support compliance checks (for example: manual evidence, API calls, or CloudTrail).

If evidence has a compliance check status of not applicable, it's classed as inconclusive in Insights data.

", + "Insights$assessmentControlsCountByNoncompliantEvidence": "

The number of assessment controls that collected non-compliant evidence on the lastUpdated date.

", + "Insights$totalAssessmentControlsCount": "

The total number of controls across all active assessments.

", + "InsightsByAssessment$noncompliantEvidenceCount": "

The number of compliance check evidence that Audit Manager classified as non-compliant. This includes evidence that was collected from Security Hub with a Fail ruling, or collected from Config with a Non-compliant ruling.

", + "InsightsByAssessment$compliantEvidenceCount": "

The number of compliance check evidence that Audit Manager classified as compliant. This includes evidence that was collected from Security Hub with a Pass ruling, or collected from Config with a Compliant ruling.

", + "InsightsByAssessment$inconclusiveEvidenceCount": "

The amount of evidence without a compliance check ruling. Evidence is inconclusive if the associated control uses Security Hub or Config as a data source and you didn't enable those services. This is also the case if a control uses a data source that doesn’t support compliance checks (for example, manual evidence, API calls, or CloudTrail).

If evidence has a compliance check status of not applicable, it's classified as inconclusive in InsightsByAssessment data.

", + "InsightsByAssessment$assessmentControlsCountByNoncompliantEvidence": "

The number of assessment controls that collected non-compliant evidence on the lastUpdated date.

", + "InsightsByAssessment$totalAssessmentControlsCount": "

The total number of controls in the assessment.

" } }, "ObjectTypeEnum": { @@ -1621,7 +1769,7 @@ "ResourceNotFoundException$message": null, "ResourceNotFoundException$resourceId": "

The unique identifier for the resource.

", "ResourceNotFoundException$resourceType": "

The type of resource that's affected by the error.

", - "UpdateAssessmentControlSetStatusRequest$controlSetId": "

The identifier for the control set.

", + "UpdateAssessmentControlSetStatusRequest$controlSetId": "

The unique identifier for the control set.

", "ValidateAssessmentReportIntegrityResponse$signatureAlgorithm": "

The signature algorithm that's used to code sign the assessment report file.

", "ValidateAssessmentReportIntegrityResponse$signatureDateTime": "

The date and time signature that specifies when the assessment report was created.

", "ValidateAssessmentReportIntegrityResponse$signatureKeyId": "

The unique identifier for the validation signature key.

", @@ -1699,6 +1847,9 @@ "Control$createdAt": "

Specifies when the control was created.

", "Control$lastUpdatedAt": "

Specifies when the control was most recently updated.

", "ControlComment$postedDate": "

The time when the comment was posted.

", + "ControlDomainInsights$lastUpdated": "

The time when the control domain insights were last updated.

", + "ControlInsightsMetadataByAssessmentItem$lastUpdated": "

The time when the assessment control insights were last updated.

", + "ControlInsightsMetadataItem$lastUpdated": "

The time when the control insights were last updated.

", "ControlMetadata$createdAt": "

Specifies when the control was created.

", "ControlMetadata$lastUpdatedAt": "

Specifies when the control was most recently updated.

", "Delegation$creationTime": "

Specifies when the delegation was created.

", @@ -1707,6 +1858,8 @@ "Evidence$time": "

The timestamp that represents when the evidence was collected.

", "Framework$createdAt": "

Specifies when the framework was created.

", "Framework$lastUpdatedAt": "

Specifies when the framework was most recently updated.

", + "Insights$lastUpdated": "

The time when the cross-assessment insights were last updated.

", + "InsightsByAssessment$lastUpdated": "

The time when the assessment insights were last updated.

", "Notification$eventTime": "

The time when the notification was sent.

" } }, @@ -1720,7 +1873,7 @@ "base": null, "refs": { "GetChangeLogsRequest$nextToken": "

The pagination token that's used to fetch the next set of results.

", - "GetChangeLogsResponse$nextToken": "

The pagination token that's used to fetch the next set of results.

", + "GetChangeLogsResponse$nextToken": "

The pagination token that's used to fetch the next set of results.

", "GetDelegationsRequest$nextToken": "

The pagination token that's used to fetch the next set of results.

", "GetDelegationsResponse$nextToken": "

The pagination token that's used to fetch the next set of results.

", "GetEvidenceByEvidenceFolderRequest$nextToken": "

The pagination token that's used to fetch the next set of results.

", @@ -1729,6 +1882,8 @@ "GetEvidenceFoldersByAssessmentControlResponse$nextToken": "

The pagination token that's used to fetch the next set of results.

", "GetEvidenceFoldersByAssessmentRequest$nextToken": "

The pagination token that's used to fetch the next set of results.

", "GetEvidenceFoldersByAssessmentResponse$nextToken": "

The pagination token that's used to fetch the next set of results.

", + "ListAssessmentControlInsightsByControlDomainRequest$nextToken": "

The pagination token that's used to fetch the next set of results.

", + "ListAssessmentControlInsightsByControlDomainResponse$nextToken": "

The pagination token that's used to fetch the next set of results.

", "ListAssessmentFrameworkShareRequestsRequest$nextToken": "

The pagination token that's used to fetch the next set of results.

", "ListAssessmentFrameworkShareRequestsResponse$nextToken": "

The pagination token that's used to fetch the next set of results.

", "ListAssessmentFrameworksRequest$nextToken": "

The pagination token that's used to fetch the next set of results.

", @@ -1737,6 +1892,12 @@ "ListAssessmentReportsResponse$nextToken": "

The pagination token that's used to fetch the next set of results.

", "ListAssessmentsRequest$nextToken": "

The pagination token that's used to fetch the next set of results.

", "ListAssessmentsResponse$nextToken": "

The pagination token that's used to fetch the next set of results.

", + "ListControlDomainInsightsByAssessmentRequest$nextToken": "

The pagination token that's used to fetch the next set of results.

", + "ListControlDomainInsightsByAssessmentResponse$nextToken": "

The pagination token that's used to fetch the next set of results.

", + "ListControlDomainInsightsRequest$nextToken": "

The pagination token that's used to fetch the next set of results.

", + "ListControlDomainInsightsResponse$nextToken": "

The pagination token that's used to fetch the next set of results.

", + "ListControlInsightsByControlDomainRequest$nextToken": "

The pagination token that's used to fetch the next set of results.

", + "ListControlInsightsByControlDomainResponse$nextToken": "

The pagination token that's used to fetch the next set of results.

", "ListControlsRequest$nextToken": "

The pagination token that's used to fetch the next set of results.

", "ListControlsResponse$nextToken": "

The pagination token that's used to fetch the next set of results.

", "ListKeywordsForDataSourceRequest$nextToken": "

The pagination token that's used to fetch the next set of results.

", @@ -1788,6 +1949,9 @@ "BatchImportEvidenceToAssessmentControlRequest$assessmentId": "

The identifier for the assessment.

", "BatchImportEvidenceToAssessmentControlRequest$controlId": "

The identifier for the control.

", "Control$id": "

The unique identifier for the control.

", + "ControlDomainInsights$id": "

The unique identifier for the control domain.

", + "ControlInsightsMetadataByAssessmentItem$id": "

The unique identifier for the assessment control.

", + "ControlInsightsMetadataItem$id": "

The unique identifier for the control.

", "ControlMappingSource$sourceId": "

The unique identifier for the source.

", "ControlMetadata$id": "

The unique identifier for the control.

", "ControlSet$id": "

The identifier of the control set in the assessment. This is the control set name in a plain string format.

", @@ -1799,44 +1963,49 @@ "DelegationIds$member": null, "DelegationMetadata$id": "

The unique identifier for the delegation.

", "DelegationMetadata$assessmentId": "

The unique identifier for the assessment.

", - "DeleteAssessmentFrameworkRequest$frameworkId": "

The identifier for the framework.

", + "DeleteAssessmentFrameworkRequest$frameworkId": "

The identifier for the custom framework.

", "DeleteAssessmentFrameworkShareRequest$requestId": "

The unique identifier for the share request to be deleted.

", - "DeleteAssessmentReportRequest$assessmentId": "

The identifier for the assessment.

", + "DeleteAssessmentReportRequest$assessmentId": "

The unique identifier for the assessment.

", "DeleteAssessmentReportRequest$assessmentReportId": "

The unique identifier for the assessment report.

", "DeleteAssessmentRequest$assessmentId": "

The identifier for the assessment.

", - "DeleteControlRequest$controlId": "

The identifier for the control.

", - "DisassociateAssessmentReportEvidenceFolderRequest$assessmentId": "

The identifier for the assessment.

", - "DisassociateAssessmentReportEvidenceFolderRequest$evidenceFolderId": "

The identifier for the folder in which evidence is stored.

", + "DeleteControlRequest$controlId": "

The unique identifier for the control.

", + "DisassociateAssessmentReportEvidenceFolderRequest$assessmentId": "

The unique identifier for the assessment.

", + "DisassociateAssessmentReportEvidenceFolderRequest$evidenceFolderId": "

The unique identifier for the folder that the evidence is stored in.

", "Evidence$evidenceFolderId": "

The identifier for the folder that the evidence is stored in.

", "Evidence$id": "

The identifier for the evidence.

", "EvidenceIds$member": null, "Framework$id": "

The unique identifier for the framework.

", "GetAssessmentFrameworkRequest$frameworkId": "

The identifier for the framework.

", - "GetAssessmentReportUrlRequest$assessmentReportId": "

The identifier for the assessment report.

", - "GetAssessmentReportUrlRequest$assessmentId": "

The identifier for the assessment.

", - "GetAssessmentRequest$assessmentId": "

The identifier for the assessment.

", - "GetChangeLogsRequest$assessmentId": "

The identifier for the assessment.

", - "GetChangeLogsRequest$controlId": "

The identifier for the control.

", + "GetAssessmentReportUrlRequest$assessmentReportId": "

The unique identifier for the assessment report.

", + "GetAssessmentReportUrlRequest$assessmentId": "

The unique identifier for the assessment.

", + "GetAssessmentRequest$assessmentId": "

The unique identifier for the assessment.

", + "GetChangeLogsRequest$assessmentId": "

The unique identifier for the assessment.

", + "GetChangeLogsRequest$controlId": "

The unique identifier for the control.

", "GetControlRequest$controlId": "

The identifier for the control.

", "GetEvidenceByEvidenceFolderRequest$assessmentId": "

The identifier for the assessment.

", "GetEvidenceByEvidenceFolderRequest$evidenceFolderId": "

The unique identifier for the folder that the evidence is stored in.

", - "GetEvidenceFolderRequest$assessmentId": "

The identifier for the assessment.

", - "GetEvidenceFolderRequest$evidenceFolderId": "

The identifier for the folder that the evidence is stored in.

", + "GetEvidenceFolderRequest$assessmentId": "

The unique identifier for the assessment.

", + "GetEvidenceFolderRequest$evidenceFolderId": "

The unique identifier for the folder that the evidence is stored in.

", "GetEvidenceFoldersByAssessmentControlRequest$assessmentId": "

The identifier for the assessment.

", "GetEvidenceFoldersByAssessmentControlRequest$controlId": "

The identifier for the control.

", - "GetEvidenceFoldersByAssessmentRequest$assessmentId": "

The identifier for the assessment.

", - "GetEvidenceRequest$assessmentId": "

The identifier for the assessment.

", - "GetEvidenceRequest$evidenceFolderId": "

The identifier for the folder that the evidence is stored in.

", - "GetEvidenceRequest$evidenceId": "

The identifier for the evidence.

", + "GetEvidenceFoldersByAssessmentRequest$assessmentId": "

The unique identifier for the assessment.

", + "GetEvidenceRequest$assessmentId": "

The unique identifier for the assessment.

", + "GetEvidenceRequest$evidenceFolderId": "

The unique identifier for the folder that the evidence is stored in.

", + "GetEvidenceRequest$evidenceId": "

The unique identifier for the evidence.

", + "GetInsightsByAssessmentRequest$assessmentId": "

The unique identifier for the assessment.

", + "ListAssessmentControlInsightsByControlDomainRequest$controlDomainId": "

The unique identifier for the control domain.

", + "ListAssessmentControlInsightsByControlDomainRequest$assessmentId": "

The unique identifier for the active assessment.

", + "ListControlDomainInsightsByAssessmentRequest$assessmentId": "

The unique identifier for the active assessment.

", + "ListControlInsightsByControlDomainRequest$controlDomainId": "

The unique identifier for the control domain.

", "Notification$assessmentId": "

The identifier for the assessment.

", "StartAssessmentFrameworkShareRequest$frameworkId": "

The unique identifier for the custom framework to be shared.

", - "UpdateAssessmentControlRequest$assessmentId": "

The identifier for the assessment.

", - "UpdateAssessmentControlRequest$controlId": "

The identifier for the control.

", - "UpdateAssessmentControlSetStatusRequest$assessmentId": "

The identifier for the assessment.

", - "UpdateAssessmentFrameworkRequest$frameworkId": "

The identifier for the framework.

", + "UpdateAssessmentControlRequest$assessmentId": "

The unique identifier for the assessment.

", + "UpdateAssessmentControlRequest$controlId": "

The unique identifier for the control.

", + "UpdateAssessmentControlSetStatusRequest$assessmentId": "

The unique identifier for the assessment.

", + "UpdateAssessmentFrameworkRequest$frameworkId": "

The unique identifier for the framework.

", "UpdateAssessmentFrameworkShareRequest$requestId": "

The unique identifier for the share request.

", - "UpdateAssessmentRequest$assessmentId": "

The identifier for the assessment.

", - "UpdateAssessmentStatusRequest$assessmentId": "

The identifier for the assessment.

", + "UpdateAssessmentRequest$assessmentId": "

The unique identifier for the assessment.

", + "UpdateAssessmentStatusRequest$assessmentId": "

The unique identifier for the assessment.

", "UpdateControlRequest$controlId": "

The identifier for the control.

" } }, diff --git a/models/apis/auditmanager/2017-07-25/paginators-1.json b/models/apis/auditmanager/2017-07-25/paginators-1.json index cd49a0ed78..ae07a740e9 100644 --- a/models/apis/auditmanager/2017-07-25/paginators-1.json +++ b/models/apis/auditmanager/2017-07-25/paginators-1.json @@ -25,6 +25,11 @@ "output_token": "nextToken", "limit_key": "maxResults" }, + "ListAssessmentControlInsightsByControlDomain": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, "ListAssessmentFrameworkShareRequests": { "input_token": "nextToken", "output_token": "nextToken", @@ -45,6 +50,21 @@ "output_token": "nextToken", "limit_key": "maxResults" }, + "ListControlDomainInsights": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListControlDomainInsightsByAssessment": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListControlInsightsByControlDomain": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, "ListControls": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/models/apis/chime-sdk-meetings/2021-07-15/api-2.json b/models/apis/chime-sdk-meetings/2021-07-15/api-2.json index a53c780c09..dccf3cd537 100644 --- a/models/apis/chime-sdk-meetings/2021-07-15/api-2.json +++ b/models/apis/chime-sdk-meetings/2021-07-15/api-2.json @@ -237,6 +237,7 @@ "Errors":{"shape":"BatchCreateAttendeeErrorList"} } }, + "Boolean":{"type":"boolean"}, "ClientRequestToken":{ "type":"string", "max":64, @@ -386,7 +387,8 @@ "Specialty":{"shape":"TranscribeMedicalSpecialty"}, "Type":{"shape":"TranscribeMedicalType"}, "VocabularyName":{"shape":"String"}, - "Region":{"shape":"TranscribeMedicalRegion"} + "Region":{"shape":"TranscribeMedicalRegion"}, + "ContentIdentificationType":{"shape":"TranscribeMedicalContentIdentificationType"} } }, "EngineTranscribeSettings":{ @@ -397,7 +399,13 @@ "VocabularyFilterMethod":{"shape":"TranscribeVocabularyFilterMethod"}, "VocabularyFilterName":{"shape":"String"}, "VocabularyName":{"shape":"String"}, - "Region":{"shape":"TranscribeRegion"} + "Region":{"shape":"TranscribeRegion"}, + "EnablePartialResultsStabilization":{"shape":"Boolean"}, + "PartialResultsStability":{"shape":"TranscribePartialResultsStability"}, + "ContentIdentificationType":{"shape":"TranscribeContentIdentificationType"}, + "ContentRedactionType":{"shape":"TranscribeContentRedactionType"}, + "PiiEntityTypes":{"shape":"TranscribePiiEntityTypes"}, + "LanguageModelName":{"shape":"TranscribeLanguageModelName"} } }, "ExternalMeetingId":{ @@ -610,6 +618,14 @@ "type":"string", "max":4096 }, + "TranscribeContentIdentificationType":{ + "type":"string", + "enum":["PII"] + }, + "TranscribeContentRedactionType":{ + "type":"string", + "enum":["PII"] + }, "TranscribeLanguageCode":{ "type":"string", "enum":[ @@ -627,6 +643,16 @@ "zh-CN" ] }, + "TranscribeLanguageModelName":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[0-9a-zA-Z._-]+" + }, + "TranscribeMedicalContentIdentificationType":{ + "type":"string", + "enum":["PHI"] + }, "TranscribeMedicalLanguageCode":{ "type":"string", "enum":["en-US"] @@ -661,6 +687,20 @@ "DICTATION" ] }, + "TranscribePartialResultsStability":{ + "type":"string", + "enum":[ + "low", + "medium", + "high" + ] + }, + "TranscribePiiEntityTypes":{ + "type":"string", + "max":300, + "min":1, + "pattern":"^[A-Z_, ]+" + }, "TranscribeRegion":{ "type":"string", "enum":[ diff --git a/models/apis/chime-sdk-meetings/2021-07-15/docs-2.json b/models/apis/chime-sdk-meetings/2021-07-15/docs-2.json index c839a31f0f..92acf96f6d 100644 --- a/models/apis/chime-sdk-meetings/2021-07-15/docs-2.json +++ b/models/apis/chime-sdk-meetings/2021-07-15/docs-2.json @@ -1,8 +1,8 @@ { "version": "2.0", - "service": "

The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications. For more information about the meeting APIs, see Amazon Chime SDK meetings.

", + "service": "

The Amazon Chime SDK meetings APIs in this section allow software developers to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create and manage users, and send and receive meeting notifications.

", "operations": { - "BatchCreateAttendee": "

Creates a group of meeting attendees.

", + "BatchCreateAttendee": "

Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", "CreateAttendee": "

Creates a new attendee for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", "CreateMeeting": "

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", "CreateMeetingWithAttendees": "

Creates a new Amazon Chime SDK meeting in the specified media Region, with attendees. For more information about specifying media Regions, see Amazon Chime SDK Media Regions in the Amazon Chime Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

", @@ -61,6 +61,12 @@ "refs": { } }, + "Boolean": { + "base": null, + "refs": { + "EngineTranscribeSettings$EnablePartialResultsStabilization": "

Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.

" + } + }, "ClientRequestToken": { "base": null, "refs": { @@ -331,12 +337,36 @@ "UnprocessableEntityException$RequestId": "

The request id associated with the call responsible for the exception.

" } }, + "TranscribeContentIdentificationType": { + "base": null, + "refs": { + "EngineTranscribeSettings$ContentIdentificationType": "

Set this field to PII to identify personal health information in the transcription output.

" + } + }, + "TranscribeContentRedactionType": { + "base": null, + "refs": { + "EngineTranscribeSettings$ContentRedactionType": "

Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.

You can’t set both ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.

" + } + }, "TranscribeLanguageCode": { "base": null, "refs": { "EngineTranscribeSettings$LanguageCode": "

The language code specified for the Amazon Transcribe engine.

" } }, + "TranscribeLanguageModelName": { + "base": null, + "refs": { + "EngineTranscribeSettings$LanguageModelName": "

The name of the language model used during transcription.

" + } + }, + "TranscribeMedicalContentIdentificationType": { + "base": null, + "refs": { + "EngineTranscribeMedicalSettings$ContentIdentificationType": "

Set this field to PHI to identify personal health information in the transcription output.

" + } + }, "TranscribeMedicalLanguageCode": { "base": null, "refs": { @@ -361,6 +391,18 @@ "EngineTranscribeMedicalSettings$Type": "

The type of transcription.

" } }, + "TranscribePartialResultsStability": { + "base": null, + "refs": { + "EngineTranscribeSettings$PartialResultsStability": "

The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.

" + } + }, + "TranscribePiiEntityTypes": { + "base": null, + "refs": { + "EngineTranscribeSettings$PiiEntityTypes": "

Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType.

PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.

PiiEntityTypes is an optional parameter with a default value of ALL.

" + } + }, "TranscribeRegion": { "base": null, "refs": { diff --git a/models/apis/chime/2018-05-01/api-2.json b/models/apis/chime/2018-05-01/api-2.json index c468b68d13..cbf583bc7f 100644 --- a/models/apis/chime/2018-05-01/api-2.json +++ b/models/apis/chime/2018-05-01/api-2.json @@ -5869,7 +5869,8 @@ "Specialty":{"shape":"TranscribeMedicalSpecialty"}, "Type":{"shape":"TranscribeMedicalType"}, "VocabularyName":{"shape":"String"}, - "Region":{"shape":"TranscribeMedicalRegion"} + "Region":{"shape":"TranscribeMedicalRegion"}, + "ContentIdentificationType":{"shape":"TranscribeMedicalContentIdentificationType"} } }, "EngineTranscribeSettings":{ @@ -5880,7 +5881,13 @@ "VocabularyFilterMethod":{"shape":"TranscribeVocabularyFilterMethod"}, "VocabularyFilterName":{"shape":"String"}, "VocabularyName":{"shape":"String"}, - "Region":{"shape":"TranscribeRegion"} + "Region":{"shape":"TranscribeRegion"}, + "EnablePartialResultsStabilization":{"shape":"Boolean"}, + "PartialResultsStability":{"shape":"TranscribePartialResultsStability"}, + "ContentIdentificationType":{"shape":"TranscribeContentIdentificationType"}, + "ContentRedactionType":{"shape":"TranscribeContentRedactionType"}, + "PiiEntityTypes":{"shape":"TranscribePiiEntityTypes"}, + "LanguageModelName":{"shape":"TranscribeLanguageModelName"} } }, "ErrorCode":{ @@ -8952,6 +8959,14 @@ "min":3, "pattern":"^8(00|33|44|55|66|77|88)$" }, + "TranscribeContentIdentificationType":{ + "type":"string", + "enum":["PII"] + }, + "TranscribeContentRedactionType":{ + "type":"string", + "enum":["PII"] + }, "TranscribeLanguageCode":{ "type":"string", "enum":[ @@ -8969,6 +8984,16 @@ "zh-CN" ] }, + "TranscribeLanguageModelName":{ + "type":"string", + "max":200, + "min":1, + "pattern":"^[0-9a-zA-Z._-]+" + }, + "TranscribeMedicalContentIdentificationType":{ + "type":"string", + "enum":["PHI"] + }, "TranscribeMedicalLanguageCode":{ "type":"string", "enum":["en-US"] @@ -9003,6 +9028,20 @@ "DICTATION" ] }, + "TranscribePartialResultsStability":{ + "type":"string", + "enum":[ + "low", + "medium", + "high" + ] + }, + "TranscribePiiEntityTypes":{ + "type":"string", + "max":300, + "min":1, + "pattern":"^[A-Z_, ]+" + }, "TranscribeRegion":{ "type":"string", "enum":[ diff --git a/models/apis/chime/2018-05-01/docs-2.json b/models/apis/chime/2018-05-01/docs-2.json index fd3c758442..87008d59e5 100644 --- a/models/apis/chime/2018-05-01/docs-2.json +++ b/models/apis/chime/2018-05-01/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "

The Amazon Chime API (application programming interface) is designed for developers to perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes. It also includes some server-side API actions to use with the Amazon Chime SDK. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.

Using an AWS SDK

You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.

Using the AWS CLI

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.

Using REST APIs

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.

", + "service": "

The Amazon Chime API (application programming interface) is designed for developers to perform key tasks, such as creating and managing Amazon Chime accounts, users, and Voice Connectors. This guide provides detailed information about the Amazon Chime API, including operations, types, inputs and outputs, and error codes. It also includes API actions for use with the Amazon Chime SDK, which developers use to build their own communication applications. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. Each API operation includes links to information about using it with a language-specific AWS SDK or the AWS CLI.

Using an AWS SDK

You don't need to write code to calculate a signature for request authentication. The SDK clients authenticate your requests by using access keys that you provide. For more information about AWS SDKs, see the AWS Developer Center.

Using the AWS CLI

Use your access keys with the AWS CLI to make API calls. For information about setting up the AWS CLI, see Installing the AWS Command Line Interface in the AWS Command Line Interface User Guide. For a list of available Amazon Chime commands, see the Amazon Chime commands in the AWS CLI Command Reference.

Using REST APIs

If you use REST to make API calls, you must authenticate your request by providing a signature. Amazon Chime supports signature version 4. For more information, see Signature Version 4 Signing Process in the Amazon Web Services General Reference.

When making REST API calls, use the service name chime and REST endpoint https://service.chime.aws.amazon.com.

Administrative permissions are controlled using AWS Identity and Access Management (IAM). For more information, see Identity and Access Management for Amazon Chime in the Amazon Chime Administration Guide.

", "operations": { "AssociatePhoneNumberWithUser": "

Associates a phone number with the specified Amazon Chime user.

", "AssociatePhoneNumbersWithVoiceConnector": "

Associates phone numbers with the specified Amazon Chime Voice Connector.

", @@ -585,6 +585,7 @@ "AccountSettings$EnableDialOut": "

Setting that allows meeting participants to choose the Call me at a phone number option. For more information, see Join a Meeting without the Amazon Chime App.

", "AlexaForBusinessMetadata$IsAlexaForBusinessEnabled": "

Starts or stops Alexa for Business.

", "CreateVoiceConnectorRequest$RequireEncryption": "

When enabled, requires encryption for the Amazon Chime Voice Connector.

", + "EngineTranscribeSettings$EnablePartialResultsStabilization": "

Generates partial transcription results that are less likely to change as meeting attendees speak. It does so by only allowing the last few words from the partial results to change.

", "LoggingConfiguration$EnableSIPLogs": "

When true, enables SIP message logs for sending to Amazon CloudWatch Logs.

", "Origination$Disabled": "

When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector. This parameter is not required, but you must specify this parameter or Routes.

", "Proxy$Disabled": "

When true, stops proxy sessions from being created on the specified Amazon Chime Voice Connector.

", @@ -3978,12 +3979,36 @@ "SearchAvailablePhoneNumbersRequest$TollFreePrefix": "

The toll-free prefix that you use to filter results. Only applies to the US.

" } }, + "TranscribeContentIdentificationType": { + "base": null, + "refs": { + "EngineTranscribeSettings$ContentIdentificationType": "

Set this field to PII to identify personal health information in the transcription output.

" + } + }, + "TranscribeContentRedactionType": { + "base": null, + "refs": { + "EngineTranscribeSettings$ContentRedactionType": "

Set this field to PII to redact personally identifiable information in the transcription output. Content redaction is performed only upon complete transcription of the audio segments.

" + } + }, "TranscribeLanguageCode": { "base": null, "refs": { "EngineTranscribeSettings$LanguageCode": "

The language code specified for the Amazon Transcribe engine.

" } }, + "TranscribeLanguageModelName": { + "base": null, + "refs": { + "EngineTranscribeSettings$LanguageModelName": "

The name of the language model used during transcription.

" + } + }, + "TranscribeMedicalContentIdentificationType": { + "base": null, + "refs": { + "EngineTranscribeMedicalSettings$ContentIdentificationType": "

Set this field to PHI to identify personal health information in the transcription output.

" + } + }, "TranscribeMedicalLanguageCode": { "base": null, "refs": { @@ -4008,6 +4033,18 @@ "EngineTranscribeMedicalSettings$Type": "

The type of transcription.

" } }, + "TranscribePartialResultsStability": { + "base": null, + "refs": { + "EngineTranscribeSettings$PartialResultsStability": "

The stabity level of a partial results transcription. Determines how stable you want the transcription results to be. A higher level means the transcription results are less likely to change.

" + } + }, + "TranscribePiiEntityTypes": { + "base": null, + "refs": { + "EngineTranscribeSettings$PiiEntityTypes": "

Lists the PII entity types you want to identify or redact. To specify entity types, you must enable ContentIdentificationType or ContentRedactionType.

PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL.

PiiEntityTypes is an optional parameter with a default value of ALL.

" + } + }, "TranscribeRegion": { "base": null, "refs": { diff --git a/models/apis/databrew/2017-07-25/api-2.json b/models/apis/databrew/2017-07-25/api-2.json index 9f8e8e1717..8cd99df5ff 100644 --- a/models/apis/databrew/2017-07-25/api-2.json +++ b/models/apis/databrew/2017-07-25/api-2.json @@ -102,6 +102,20 @@ {"shape":"ValidationException"} ] }, + "CreateRuleset":{ + "name":"CreateRuleset", + "http":{ + "method":"POST", + "requestUri":"/rulesets" + }, + "input":{"shape":"CreateRulesetRequest"}, + "output":{"shape":"CreateRulesetResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"} + ] + }, "CreateSchedule":{ "name":"CreateSchedule", "http":{ @@ -172,6 +186,20 @@ {"shape":"ValidationException"} ] }, + "DeleteRuleset":{ + "name":"DeleteRuleset", + "http":{ + "method":"DELETE", + "requestUri":"/rulesets/{name}" + }, + "input":{"shape":"DeleteRulesetRequest"}, + "output":{"shape":"DeleteRulesetResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"} + ] + }, "DeleteSchedule":{ "name":"DeleteSchedule", "http":{ @@ -250,6 +278,19 @@ {"shape":"ValidationException"} ] }, + "DescribeRuleset":{ + "name":"DescribeRuleset", + "http":{ + "method":"GET", + "requestUri":"/rulesets/{name}" + }, + "input":{"shape":"DescribeRulesetRequest"}, + "output":{"shape":"DescribeRulesetResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ] + }, "DescribeSchedule":{ "name":"DescribeSchedule", "http":{ @@ -336,6 +377,19 @@ {"shape":"ValidationException"} ] }, + "ListRulesets":{ + "name":"ListRulesets", + "http":{ + "method":"GET", + "requestUri":"/rulesets" + }, + "input":{"shape":"ListRulesetsRequest"}, + "output":{"shape":"ListRulesetsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ] + }, "ListSchedules":{ "name":"ListSchedules", "http":{ @@ -529,6 +583,19 @@ {"shape":"ValidationException"} ] }, + "UpdateRuleset":{ + "name":"UpdateRuleset", + "http":{ + "method":"PUT", + "requestUri":"/rulesets/{name}" + }, + "input":{"shape":"UpdateRulesetRequest"}, + "output":{"shape":"UpdateRulesetResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"} + ] + }, "UpdateSchedule":{ "name":"UpdateSchedule", "http":{ @@ -558,6 +625,25 @@ "max":255 }, "ActionId":{"type":"integer"}, + "AllowedStatisticList":{ + "type":"list", + "member":{"shape":"AllowedStatistics"}, + "min":1 + }, + "AllowedStatistics":{ + "type":"structure", + "required":["Statistics"], + "members":{ + "Statistics":{"shape":"StatisticList"} + } + }, + "AnalyticsMode":{ + "type":"string", + "enum":[ + "ENABLE", + "DISABLE" + ] + }, "Arn":{ "type":"string", "max":2048, @@ -602,7 +688,8 @@ "type":"string", "max":255, "min":1, - "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]*$" + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9-]*$", + "sensitive":true }, "ColumnName":{ "type":"string", @@ -733,6 +820,7 @@ "MaxRetries":{"shape":"MaxRetries"}, "OutputLocation":{"shape":"S3Location"}, "Configuration":{"shape":"ProfileConfiguration"}, + "ValidationConfigurations":{"shape":"ValidationConfigurationList"}, "RoleArn":{"shape":"Arn"}, "Tags":{"shape":"TagMap"}, "Timeout":{"shape":"Timeout"}, @@ -821,6 +909,28 @@ "Name":{"shape":"RecipeName"} } }, + "CreateRulesetRequest":{ + "type":"structure", + "required":[ + "Name", + "TargetArn", + "Rules" + ], + "members":{ + "Name":{"shape":"RulesetName"}, + "Description":{"shape":"RulesetDescription"}, + "TargetArn":{"shape":"Arn"}, + "Rules":{"shape":"RuleList"}, + "Tags":{"shape":"TagMap"} + } + }, + "CreateRulesetResponse":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"RulesetName"} + } + }, "CreateScheduleRequest":{ "type":"structure", "required":[ @@ -895,14 +1005,12 @@ }, "DatabaseInputDefinition":{ "type":"structure", - "required":[ - "GlueConnectionName", - "DatabaseTableName" - ], + "required":["GlueConnectionName"], "members":{ "GlueConnectionName":{"shape":"GlueConnectionName"}, "DatabaseTableName":{"shape":"DatabaseTableName"}, - "TempDirectory":{"shape":"S3Location"} + "TempDirectory":{"shape":"S3Location"}, + "QueryString":{"shape":"QueryString"} } }, "DatabaseName":{ @@ -1088,6 +1196,24 @@ "RecipeVersion":{"shape":"RecipeVersion"} } }, + "DeleteRulesetRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"RulesetName", + "location":"uri", + "locationName":"name" + } + } + }, + "DeleteRulesetResponse":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"RulesetName"} + } + }, "DeleteScheduleRequest":{ "type":"structure", "required":["Name"], @@ -1175,6 +1301,7 @@ "DatabaseOutputs":{"shape":"DatabaseOutputList"}, "ProjectName":{"shape":"ProjectName"}, "ProfileConfiguration":{"shape":"ProfileConfiguration"}, + "ValidationConfigurations":{"shape":"ValidationConfigurationList"}, "RecipeReference":{"shape":"RecipeReference"}, "ResourceArn":{"shape":"Arn"}, "RoleArn":{"shape":"Arn"}, @@ -1213,6 +1340,7 @@ "ExecutionTime":{"shape":"ExecutionTime"}, "JobName":{"shape":"JobName"}, "ProfileConfiguration":{"shape":"ProfileConfiguration"}, + "ValidationConfigurations":{"shape":"ValidationConfigurationList"}, "RunId":{"shape":"JobRunId"}, "State":{"shape":"JobRunState"}, "LogSubscription":{"shape":"LogSubscription"}, @@ -1292,6 +1420,33 @@ "RecipeVersion":{"shape":"RecipeVersion"} } }, + "DescribeRulesetRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"RulesetName", + "location":"uri", + "locationName":"name" + } + } + }, + "DescribeRulesetResponse":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"RulesetName"}, + "Description":{"shape":"RulesetDescription"}, + "TargetArn":{"shape":"Arn"}, + "Rules":{"shape":"RuleList"}, + "CreateDate":{"shape":"Date"}, + "CreatedBy":{"shape":"CreatedBy"}, + "LastModifiedBy":{"shape":"LastModifiedBy"}, + "LastModifiedDate":{"shape":"Date"}, + "ResourceArn":{"shape":"Arn"}, + "Tags":{"shape":"TagMap"} + } + }, "DescribeScheduleRequest":{ "type":"structure", "required":["Name"], @@ -1318,6 +1473,7 @@ "Name":{"shape":"ScheduleName"} } }, + "Disabled":{"type":"boolean"}, "EncryptionKeyArn":{ "type":"string", "max":2048, @@ -1330,6 +1486,25 @@ "SSE-S3" ] }, + "EntityDetectorConfiguration":{ + "type":"structure", + "required":["EntityTypes"], + "members":{ + "EntityTypes":{"shape":"EntityTypeList"}, + "AllowedStatistics":{"shape":"AllowedStatisticList"} + } + }, + "EntityType":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^[A-Z_][A-Z\\\\d_]*$" + }, + "EntityTypeList":{ + "type":"list", + "member":{"shape":"EntityType"}, + "min":1 + }, "ErrorCode":{ "type":"string", "pattern":"^[1-5][0-9][0-9]$" @@ -1347,7 +1522,7 @@ "type":"string", "max":1024, "min":4, - "pattern":"^[<>0-9A-Za-z_:)(!= ]+$" + "pattern":"^[<>0-9A-Za-z_.,:)(!= ]+$" }, "FilesLimit":{ "type":"structure", @@ -1392,7 +1567,8 @@ "members":{ "S3InputDefinition":{"shape":"S3Location"}, "DataCatalogInputDefinition":{"shape":"DataCatalogInputDefinition"}, - "DatabaseInputDefinition":{"shape":"DatabaseInputDefinition"} + "DatabaseInputDefinition":{"shape":"DatabaseInputDefinition"}, + "Metadata":{"shape":"Metadata"} } }, "InputFormat":{ @@ -1438,7 +1614,8 @@ "RoleArn":{"shape":"Arn"}, "Timeout":{"shape":"Timeout"}, "Tags":{"shape":"TagMap"}, - "JobSample":{"shape":"JobSample"} + "JobSample":{"shape":"JobSample"}, + "ValidationConfigurations":{"shape":"ValidationConfigurationList"} } }, "JobList":{ @@ -1474,7 +1651,8 @@ "RecipeReference":{"shape":"RecipeReference"}, "StartedBy":{"shape":"StartedBy"}, "StartedOn":{"shape":"Date"}, - "JobSample":{"shape":"JobSample"} + "JobSample":{"shape":"JobSample"}, + "ValidationConfigurations":{"shape":"ValidationConfigurationList"} } }, "JobRunErrorMessage":{"type":"string"}, @@ -1691,6 +1869,34 @@ "NextToken":{"shape":"NextToken"} } }, + "ListRulesetsRequest":{ + "type":"structure", + "members":{ + "TargetArn":{ + "shape":"Arn", + "location":"querystring", + "locationName":"targetArn" + }, + "MaxResults":{ + "shape":"MaxResults100", + "location":"querystring", + "locationName":"maxResults" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListRulesetsResponse":{ + "type":"structure", + "required":["Rulesets"], + "members":{ + "Rulesets":{"shape":"RulesetItemList"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListSchedulesRequest":{ "type":"structure", "members":{ @@ -1769,6 +1975,12 @@ "min":0 }, "Message":{"type":"string"}, + "Metadata":{ + "type":"structure", + "members":{ + "SourceArn":{"shape":"Arn"} + } + }, "MultiLine":{"type":"boolean"}, "NextToken":{ "type":"string", @@ -1880,7 +2092,8 @@ "members":{ "DatasetStatisticsConfiguration":{"shape":"StatisticsConfiguration"}, "ProfileColumns":{"shape":"ColumnSelectorList"}, - "ColumnStatisticsConfigurations":{"shape":"ColumnStatisticsConfigurationList"} + "ColumnStatisticsConfigurations":{"shape":"ColumnStatisticsConfigurationList"}, + "EntityDetectorConfiguration":{"shape":"EntityDetectorConfiguration"} } }, "Project":{ @@ -1935,6 +2148,11 @@ } }, "PublishedBy":{"type":"string"}, + "QueryString":{ + "type":"string", + "max":10000, + "min":1 + }, "Recipe":{ "type":"structure", "required":["Name"], @@ -2028,6 +2246,69 @@ "exception":true }, "Result":{"type":"string"}, + "RowRange":{"type":"integer"}, + "Rule":{ + "type":"structure", + "required":[ + "Name", + "CheckExpression" + ], + "members":{ + "Name":{"shape":"RuleName"}, + "Disabled":{"shape":"Disabled"}, + "CheckExpression":{"shape":"Expression"}, + "SubstitutionMap":{"shape":"ValuesMap"}, + "Threshold":{"shape":"Threshold"}, + "ColumnSelectors":{"shape":"ColumnSelectorList"} + } + }, + "RuleCount":{ + "type":"integer", + "min":0 + }, + "RuleList":{ + "type":"list", + "member":{"shape":"Rule"}, + "min":1 + }, + "RuleName":{ + "type":"string", + "max":128, + "min":1 + }, + "RulesetDescription":{ + "type":"string", + "max":1024 + }, + "RulesetItem":{ + "type":"structure", + "required":[ + "Name", + "TargetArn" + ], + "members":{ + "AccountId":{"shape":"AccountId"}, + "CreatedBy":{"shape":"CreatedBy"}, + "CreateDate":{"shape":"Date"}, + "Description":{"shape":"RulesetDescription"}, + "LastModifiedBy":{"shape":"LastModifiedBy"}, + "LastModifiedDate":{"shape":"Date"}, + "Name":{"shape":"RulesetName"}, + "ResourceArn":{"shape":"Arn"}, + "RuleCount":{"shape":"RuleCount"}, + "Tags":{"shape":"TagMap"}, + "TargetArn":{"shape":"Arn"} + } + }, + "RulesetItemList":{ + "type":"list", + "member":{"shape":"RulesetItem"} + }, + "RulesetName":{ + "type":"string", + "max":255, + "min":1 + }, "S3Location":{ "type":"structure", "required":["Bucket"], @@ -2216,6 +2497,10 @@ "ClientSessionId":{"shape":"ClientSessionId"} } }, + "StartRowIndex":{ + "type":"integer", + "min":0 + }, "StartedBy":{"type":"string"}, "Statistic":{ "type":"string", @@ -2333,6 +2618,35 @@ "max":1024, "min":1 }, + "Threshold":{ + "type":"structure", + "required":["Value"], + "members":{ + "Value":{"shape":"ThresholdValue"}, + "Type":{"shape":"ThresholdType"}, + "Unit":{"shape":"ThresholdUnit"} + } + }, + "ThresholdType":{ + "type":"string", + "enum":[ + "GREATER_THAN_OR_EQUAL", + "LESS_THAN_OR_EQUAL", + "GREATER_THAN", + "LESS_THAN" + ] + }, + "ThresholdUnit":{ + "type":"string", + "enum":[ + "COUNT", + "PERCENTAGE" + ] + }, + "ThresholdValue":{ + "type":"double", + "min":0 + }, "Timeout":{ "type":"integer", "min":0 @@ -2412,6 +2726,7 @@ "MaxCapacity":{"shape":"MaxCapacity"}, "MaxRetries":{"shape":"MaxRetries"}, "OutputLocation":{"shape":"S3Location"}, + "ValidationConfigurations":{"shape":"ValidationConfigurationList"}, "RoleArn":{"shape":"Arn"}, "Timeout":{"shape":"Timeout"}, "JobSample":{"shape":"JobSample"} @@ -2499,6 +2814,29 @@ "Name":{"shape":"RecipeName"} } }, + "UpdateRulesetRequest":{ + "type":"structure", + "required":[ + "Name", + "Rules" + ], + "members":{ + "Name":{ + "shape":"RulesetName", + "location":"uri", + "locationName":"name" + }, + "Description":{"shape":"RulesetDescription"}, + "Rules":{"shape":"RuleList"} + } + }, + "UpdateRulesetResponse":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"RulesetName"} + } + }, "UpdateScheduleRequest":{ "type":"structure", "required":[ @@ -2522,6 +2860,19 @@ "Name":{"shape":"ScheduleName"} } }, + "ValidationConfiguration":{ + "type":"structure", + "required":["RulesetArn"], + "members":{ + "RulesetArn":{"shape":"Arn"}, + "ValidationMode":{"shape":"ValidationMode"} + } + }, + "ValidationConfigurationList":{ + "type":"list", + "member":{"shape":"ValidationConfiguration"}, + "min":1 + }, "ValidationException":{ "type":"structure", "members":{ @@ -2530,6 +2881,10 @@ "error":{"httpStatusCode":400}, "exception":true }, + "ValidationMode":{ + "type":"string", + "enum":["CHECK_ALL"] + }, "ValueReference":{ "type":"string", "max":128, @@ -2547,7 +2902,10 @@ "members":{ "StartColumnIndex":{"shape":"StartColumnIndex"}, "ColumnRange":{"shape":"ColumnRange"}, - "HiddenColumns":{"shape":"HiddenColumnList"} + "HiddenColumns":{"shape":"HiddenColumnList"}, + "StartRowIndex":{"shape":"StartRowIndex"}, + "RowRange":{"shape":"RowRange"}, + "Analytics":{"shape":"AnalyticsMode"} } } } diff --git a/models/apis/databrew/2017-07-25/docs-2.json b/models/apis/databrew/2017-07-25/docs-2.json index d8179a844d..843f38617e 100644 --- a/models/apis/databrew/2017-07-25/docs-2.json +++ b/models/apis/databrew/2017-07-25/docs-2.json @@ -8,17 +8,20 @@ "CreateProject": "

Creates a new DataBrew project.

", "CreateRecipe": "

Creates a new DataBrew recipe.

", "CreateRecipeJob": "

Creates a new job to transform input data, using steps defined in an existing Glue DataBrew recipe

", + "CreateRuleset": "

Creates a new ruleset that can be used in a profile job to validate the data quality of a dataset.

", "CreateSchedule": "

Creates a new schedule for one or more DataBrew jobs. Jobs can be run at a specific date and time, or at regular intervals.

", "DeleteDataset": "

Deletes a dataset from DataBrew.

", "DeleteJob": "

Deletes the specified DataBrew job.

", "DeleteProject": "

Deletes an existing DataBrew project.

", "DeleteRecipeVersion": "

Deletes a single version of a DataBrew recipe.

", + "DeleteRuleset": "

Deletes a ruleset.

", "DeleteSchedule": "

Deletes the specified DataBrew schedule.

", "DescribeDataset": "

Returns the definition of a specific DataBrew dataset.

", "DescribeJob": "

Returns the definition of a specific DataBrew job.

", "DescribeJobRun": "

Represents one run of a DataBrew job.

", "DescribeProject": "

Returns the definition of a specific DataBrew project.

", "DescribeRecipe": "

Returns the definition of a specific DataBrew recipe corresponding to a particular version.

", + "DescribeRuleset": "

Retrieves detailed information about the ruleset.

", "DescribeSchedule": "

Returns the definition of a specific DataBrew schedule.

", "ListDatasets": "

Lists all of the DataBrew datasets.

", "ListJobRuns": "

Lists all of the previous runs of a particular DataBrew job.

", @@ -26,6 +29,7 @@ "ListProjects": "

Lists all of the DataBrew projects that are defined.

", "ListRecipeVersions": "

Lists the versions of a particular DataBrew recipe, except for LATEST_WORKING.

", "ListRecipes": "

Lists all of the DataBrew recipes that are defined.

", + "ListRulesets": "

List all rulesets available in the current account or rulesets associated with a specific resource (dataset).

", "ListSchedules": "

Lists the DataBrew schedules that are defined.

", "ListTagsForResource": "

Lists all the tags for a DataBrew resource.

", "PublishRecipe": "

Publishes a new version of a DataBrew recipe.

", @@ -40,6 +44,7 @@ "UpdateProject": "

Modifies the definition of an existing DataBrew project.

", "UpdateRecipe": "

Modifies the definition of the LATEST_WORKING version of a DataBrew recipe.

", "UpdateRecipeJob": "

Modifies the definition of an existing DataBrew recipe job.

", + "UpdateRuleset": "

Updates specified ruleset.

", "UpdateSchedule": "

Modifies the definition of an existing DataBrew schedule.

" }, "shapes": { @@ -54,6 +59,7 @@ "Dataset$AccountId": "

The ID of the Amazon Web Services account that owns the dataset.

", "Job$AccountId": "

The ID of the Amazon Web Services account that owns the job.

", "Project$AccountId": "

The ID of the Amazon Web Services account that owns the project.

", + "RulesetItem$AccountId": "

The ID of the Amazon Web Services account that owns the ruleset.

", "Schedule$AccountId": "

The ID of the Amazon Web Services account that owns the schedule.

" } }, @@ -63,12 +69,31 @@ "SendProjectSessionActionResponse$ActionId": "

A unique identifier for the action that was performed.

" } }, + "AllowedStatisticList": { + "base": null, + "refs": { + "EntityDetectorConfiguration$AllowedStatistics": "

Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.

" + } + }, + "AllowedStatistics": { + "base": "

Configuration of statistics that are allowed to be run on columns that contain detected entities. When undefined, no statistics will be computed on columns that contain detected entities.

", + "refs": { + "AllowedStatisticList$member": null + } + }, + "AnalyticsMode": { + "base": null, + "refs": { + "ViewFrame$Analytics": "

Controls if analytics computation is enabled or disabled. Enabled by default.

" + } + }, "Arn": { "base": null, "refs": { "CreateProfileJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

", "CreateProjectRequest$RoleArn": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed for this request.

", "CreateRecipeJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

", + "CreateRulesetRequest$TargetArn": "

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

", "Dataset$ResourceArn": "

The unique Amazon Resource Name (ARN) for the dataset.

", "DescribeDatasetResponse$ResourceArn": "

The Amazon Resource Name (ARN) of the dataset.

", "DescribeJobResponse$ResourceArn": "

The Amazon Resource Name (ARN) of the job.

", @@ -76,19 +101,26 @@ "DescribeProjectResponse$ResourceArn": "

The Amazon Resource Name (ARN) of the project.

", "DescribeProjectResponse$RoleArn": "

The ARN of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

", "DescribeRecipeResponse$ResourceArn": "

The ARN of the recipe.

", + "DescribeRulesetResponse$TargetArn": "

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

", + "DescribeRulesetResponse$ResourceArn": "

The Amazon Resource Name (ARN) for the ruleset.

", "DescribeScheduleResponse$ResourceArn": "

The Amazon Resource Name (ARN) of the schedule.

", "Job$ResourceArn": "

The unique Amazon Resource Name (ARN) for the job.

", "Job$RoleArn": "

The Amazon Resource Name (ARN) of the role to be assumed for this job.

", + "ListRulesetsRequest$TargetArn": "

The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter indicates to return only those rulesets that are associated with the specified resource.

", "ListTagsForResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) string that uniquely identifies the DataBrew resource.

", + "Metadata$SourceArn": "

The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew only supports ARNs from Amazon AppFlow.

", "Project$ResourceArn": "

The Amazon Resource Name (ARN) for the project.

", "Project$RoleArn": "

The Amazon Resource Name (ARN) of the role that will be assumed for this project.

", "Recipe$ResourceArn": "

The Amazon Resource Name (ARN) for the recipe.

", + "RulesetItem$ResourceArn": "

The Amazon Resource Name (ARN) for the ruleset.

", + "RulesetItem$TargetArn": "

The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is associated with.

", "Schedule$ResourceArn": "

The Amazon Resource Name (ARN) of the schedule.

", "TagResourceRequest$ResourceArn": "

The DataBrew resource to which tags should be added. The value for this parameter is an Amazon Resource Name (ARN). For DataBrew, you can tag a dataset, a job, a project, or a recipe.

", "UntagResourceRequest$ResourceArn": "

A DataBrew resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).

", "UpdateProfileJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

", "UpdateProjectRequest$RoleArn": "

The Amazon Resource Name (ARN) of the IAM role to be assumed for this request.

", - "UpdateRecipeJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

" + "UpdateRecipeJobRequest$RoleArn": "

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role to be assumed when DataBrew runs the job.

", + "ValidationConfiguration$RulesetArn": "

The Amazon Resource Name (ARN) for the ruleset to be validated in the profile job. The TargetArn of the selected ruleset should be the same as the Amazon Resource Name (ARN) of the dataset that is associated with the profile job.

" } }, "AssumeControl": { @@ -165,7 +197,8 @@ "base": null, "refs": { "ColumnStatisticsConfiguration$Selectors": "

List of column selectors. Selectors can be used to select columns from the dataset. When selectors are undefined, configuration will be applied to all supported columns.

", - "ProfileConfiguration$ProfileColumns": "

List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.

" + "ProfileConfiguration$ProfileColumns": "

List of column selectors. ProfileColumns can be used to select columns from the dataset. When ProfileColumns is undefined, the profile job will profile all supported columns.

", + "Rule$ColumnSelectors": "

List of column selectors. Selectors can be used to select columns using a name or regular expression from the dataset. Rule will be applied to selected columns.

" } }, "ColumnStatisticsConfiguration": { @@ -272,6 +305,16 @@ "refs": { } }, + "CreateRulesetRequest": { + "base": null, + "refs": { + } + }, + "CreateRulesetResponse": { + "base": null, + "refs": { + } + }, "CreateScheduleRequest": { "base": null, "refs": { @@ -290,10 +333,12 @@ "DescribeJobResponse$CreatedBy": "

The identifier (user name) of the user associated with the creation of the job.

", "DescribeProjectResponse$CreatedBy": "

The identifier (user name) of the user who created the project.

", "DescribeRecipeResponse$CreatedBy": "

The identifier (user name) of the user who created the recipe.

", + "DescribeRulesetResponse$CreatedBy": "

The Amazon Resource Name (ARN) of the user who created the ruleset.

", "DescribeScheduleResponse$CreatedBy": "

The identifier (user name) of the user who created the schedule.

", "Job$CreatedBy": "

The Amazon Resource Name (ARN) of the user who created the job.

", "Project$CreatedBy": "

The Amazon Resource Name (ARN) of the user who crated the project.

", "Recipe$CreatedBy": "

The Amazon Resource Name (ARN) of the user who created the recipe.

", + "RulesetItem$CreatedBy": "

The Amazon Resource Name (ARN) of the user who created the ruleset.

", "Schedule$CreatedBy": "

The Amazon Resource Name (ARN) of the user who created the schedule.

" } }, @@ -450,6 +495,8 @@ "DescribeRecipeResponse$CreateDate": "

The date and time that the recipe was created.

", "DescribeRecipeResponse$LastModifiedDate": "

The date and time that the recipe was last modified.

", "DescribeRecipeResponse$PublishedDate": "

The date and time when the recipe was last published.

", + "DescribeRulesetResponse$CreateDate": "

The date and time that the ruleset was created.

", + "DescribeRulesetResponse$LastModifiedDate": "

The modification date and time of the ruleset.

", "DescribeScheduleResponse$CreateDate": "

The date and time that the schedule was created.

", "DescribeScheduleResponse$LastModifiedDate": "

The date and time that the schedule was last modified.

", "Job$CreateDate": "

The date and time that the job was created.

", @@ -462,6 +509,8 @@ "Recipe$CreateDate": "

The date and time that the recipe was created.

", "Recipe$LastModifiedDate": "

The last modification date and time of the recipe.

", "Recipe$PublishedDate": "

The date and time when the recipe was published.

", + "RulesetItem$CreateDate": "

The date and time that the ruleset was created.

", + "RulesetItem$LastModifiedDate": "

The modification date and time of the ruleset.

", "Schedule$CreateDate": "

The date and time that the schedule was created.

", "Schedule$LastModifiedDate": "

The date and time when the schedule was last modified.

", "UpdateProjectResponse$LastModifiedDate": "

The date and time that the project was last modified.

" @@ -519,6 +568,16 @@ "refs": { } }, + "DeleteRulesetRequest": { + "base": null, + "refs": { + } + }, + "DeleteRulesetResponse": { + "base": null, + "refs": { + } + }, "DeleteScheduleRequest": { "base": null, "refs": { @@ -586,6 +645,16 @@ "refs": { } }, + "DescribeRulesetRequest": { + "base": null, + "refs": { + } + }, + "DescribeRulesetResponse": { + "base": null, + "refs": { + } + }, "DescribeScheduleRequest": { "base": null, "refs": { @@ -596,6 +665,12 @@ "refs": { } }, + "Disabled": { + "base": null, + "refs": { + "Rule$Disabled": "

A value that specifies whether the rule is disabled. Once a rule is disabled, a profile job will not validate it during a job run. Default value is false.

" + } + }, "EncryptionKeyArn": { "base": null, "refs": { @@ -618,6 +693,24 @@ "UpdateRecipeJobRequest$EncryptionMode": "

The encryption mode for the job, which can be one of the following:

" } }, + "EntityDetectorConfiguration": { + "base": "

Configuration of entity detection for a profile job. When undefined, entity detection is disabled.

", + "refs": { + "ProfileConfiguration$EntityDetectorConfiguration": "

Configuration of entity detection for a profile job. When undefined, entity detection is disabled.

" + } + }, + "EntityType": { + "base": null, + "refs": { + "EntityTypeList$member": null + } + }, + "EntityTypeList": { + "base": null, + "refs": { + "EntityDetectorConfiguration$EntityTypes": "

Entity types to detect. Can be any of the following:

The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

" + } + }, "ErrorCode": { "base": null, "refs": { @@ -640,7 +733,8 @@ "Expression": { "base": null, "refs": { - "FilterExpression$Expression": "

The expression which includes condition names followed by substitution variables, possibly grouped and combined with other conditions. For example, \"(starts_with :prefix1 or starts_with :prefix2) and (ends_with :suffix1 or ends_with :suffix2)\". Substitution variables should start with ':' symbol.

" + "FilterExpression$Expression": "

The expression which includes condition names followed by substitution variables, possibly grouped and combined with other conditions. For example, \"(starts_with :prefix1 or starts_with :prefix2) and (ends_with :suffix1 or ends_with :suffix2)\". Substitution variables should start with ':' symbol.

", + "Rule$CheckExpression": "

The expression which includes column references, condition names followed by variable references, possibly grouped and combined with other conditions. For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and (:col1 ends_with :suffix1 or :col1 ends_with :suffix2). Column and value references are substitution variables that should start with the ':' symbol. Depending on the context, substitution variables' values can be either an actual value or a column name. These values are defined in the SubstitutionMap. If a CheckExpression starts with a column reference, then ColumnSelectors in the rule should be null. If ColumnSelectors has been defined, then there should be no columnn reference in the left side of a condition, for example, is_between :val1 and :val2.

" } }, "FilesLimit": { @@ -650,7 +744,7 @@ } }, "FilterExpression": { - "base": "

Represents a structure for defining parameter conditions. Supported conditions are described here: Supported conditions for dynamic datasets in the Glue DataBrew Developer Guide.

", + "base": "

Represents a structure for defining parameter conditions. Supported conditions are described here: Supported conditions for dynamic datasets in the Glue DataBrew Developer Guide.

", "refs": { "DatasetParameter$Filter": "

The optional filter expression structure to apply additional matching criteria to the parameter.

", "PathOptions$LastModifiedDateCondition": "

If provided, this structure defines a date range for matching Amazon S3 objects based on their LastModifiedDate attribute in Amazon S3.

" @@ -836,10 +930,12 @@ "DescribeJobResponse$LastModifiedBy": "

The identifier (user name) of the user who last modified the job.

", "DescribeProjectResponse$LastModifiedBy": "

The identifier (user name) of the user who last modified the project.

", "DescribeRecipeResponse$LastModifiedBy": "

The identifier (user name) of the user who last modified the recipe.

", + "DescribeRulesetResponse$LastModifiedBy": "

The Amazon Resource Name (ARN) of the user who last modified the ruleset.

", "DescribeScheduleResponse$LastModifiedBy": "

The identifier (user name) of the user who last modified the schedule.

", "Job$LastModifiedBy": "

The Amazon Resource Name (ARN) of the user who last modified the job.

", "Project$LastModifiedBy": "

The Amazon Resource Name (ARN) of the user who last modified the project.

", "Recipe$LastModifiedBy": "

The Amazon Resource Name (ARN) of the user who last modified the recipe.

", + "RulesetItem$LastModifiedBy": "

The Amazon Resource Name (ARN) of the user who last modified the ruleset.

", "Schedule$LastModifiedBy": "

The Amazon Resource Name (ARN) of the user who last modified the schedule.

" } }, @@ -903,6 +999,16 @@ "refs": { } }, + "ListRulesetsRequest": { + "base": null, + "refs": { + } + }, + "ListRulesetsResponse": { + "base": null, + "refs": { + } + }, "ListSchedulesRequest": { "base": null, "refs": { @@ -975,6 +1081,7 @@ "ListProjectsRequest$MaxResults": "

The maximum number of results to return in this request.

", "ListRecipeVersionsRequest$MaxResults": "

The maximum number of results to return in this request.

", "ListRecipesRequest$MaxResults": "

The maximum number of results to return in this request.

", + "ListRulesetsRequest$MaxResults": "

The maximum number of results to return in this request.

", "ListSchedulesRequest$MaxResults": "

The maximum number of results to return in this request.

" } }, @@ -1000,6 +1107,12 @@ "ValidationException$Message": null } }, + "Metadata": { + "base": "

Contains additional resource information needed for specific datasets.

", + "refs": { + "Input$Metadata": "

Contains additional resource information needed for specific datasets.

" + } + }, "MultiLine": { "base": null, "refs": { @@ -1021,6 +1134,8 @@ "ListRecipeVersionsResponse$NextToken": "

A token that you can use in a subsequent call to retrieve the next set of results.

", "ListRecipesRequest$NextToken": "

The token returned by a previous call to retrieve the next set of results.

", "ListRecipesResponse$NextToken": "

A token that you can use in a subsequent call to retrieve the next set of results.

", + "ListRulesetsRequest$NextToken": "

A token generated by DataBrew that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the NextToken value from the response object of the previous page call.

", + "ListRulesetsResponse$NextToken": "

A token that you can use in a subsequent call to retrieve the next set of results.

", "ListSchedulesRequest$NextToken": "

The token returned by a previous call to retrieve the next set of results.

", "ListSchedulesResponse$NextToken": "

A token that you can use in a subsequent call to retrieve the next set of results.

" } @@ -1201,6 +1316,12 @@ "Recipe$PublishedBy": "

The Amazon Resource Name (ARN) of the user who published the recipe.

" } }, + "QueryString": { + "base": null, + "refs": { + "DatabaseInputDefinition$QueryString": "

Custom SQL to run against the provided Glue connection. This SQL will be used as the input for DataBrew projects and jobs.

" + } + }, "Recipe": { "base": "

Represents one or more actions to be performed on a DataBrew dataset.

", "refs": { @@ -1328,6 +1449,73 @@ "SendProjectSessionActionResponse$Result": "

A message indicating the result of performing the action.

" } }, + "RowRange": { + "base": null, + "refs": { + "ViewFrame$RowRange": "

The number of rows to include in the view frame, beginning with the StartRowIndex value.

" + } + }, + "Rule": { + "base": "

Represents a single data quality requirement that should be validated in the scope of this dataset.

", + "refs": { + "RuleList$member": null + } + }, + "RuleCount": { + "base": null, + "refs": { + "RulesetItem$RuleCount": "

The number of rules that are defined in the ruleset.

" + } + }, + "RuleList": { + "base": null, + "refs": { + "CreateRulesetRequest$Rules": "

A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.

", + "DescribeRulesetResponse$Rules": "

A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.

", + "UpdateRulesetRequest$Rules": "

A list of rules that are defined with the ruleset. A rule includes one or more checks to be validated on a DataBrew dataset.

" + } + }, + "RuleName": { + "base": null, + "refs": { + "Rule$Name": "

The name of the rule.

" + } + }, + "RulesetDescription": { + "base": null, + "refs": { + "CreateRulesetRequest$Description": "

The description of the ruleset.

", + "DescribeRulesetResponse$Description": "

The description of the ruleset.

", + "RulesetItem$Description": "

The description of the ruleset.

", + "UpdateRulesetRequest$Description": "

The description of the ruleset.

" + } + }, + "RulesetItem": { + "base": "

Contains metadata about the ruleset.

", + "refs": { + "RulesetItemList$member": null + } + }, + "RulesetItemList": { + "base": null, + "refs": { + "ListRulesetsResponse$Rulesets": "

A list of RulesetItem. RulesetItem contains meta data of a ruleset.

" + } + }, + "RulesetName": { + "base": null, + "refs": { + "CreateRulesetRequest$Name": "

The name of the ruleset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.

", + "CreateRulesetResponse$Name": "

The unique name of the created ruleset.

", + "DeleteRulesetRequest$Name": "

The name of the ruleset to be deleted.

", + "DeleteRulesetResponse$Name": "

The name of the deleted ruleset.

", + "DescribeRulesetRequest$Name": "

The name of the ruleset to be described.

", + "DescribeRulesetResponse$Name": "

The name of the ruleset.

", + "RulesetItem$Name": "

The name of the ruleset.

", + "UpdateRulesetRequest$Name": "

The name of the ruleset to be updated.

", + "UpdateRulesetResponse$Name": "

The name of the updated ruleset.

" + } + }, "S3Location": { "base": "

Represents an Amazon S3 location (bucket name and object key) where DataBrew can read input data, or write output from a job.

", "refs": { @@ -1478,6 +1666,12 @@ "refs": { } }, + "StartRowIndex": { + "base": null, + "refs": { + "ViewFrame$StartRowIndex": "

The starting index for the range of rows to return in the view frame.

" + } + }, "StartedBy": { "base": null, "refs": { @@ -1495,6 +1689,7 @@ "StatisticList": { "base": null, "refs": { + "AllowedStatistics$Statistics": "

One or more column statistics to allow for columns that contain detected entities.

", "StatisticsConfiguration$IncludedStatistics": "

List of included evaluations. When the list is undefined, all supported evaluations will be included.

" } }, @@ -1561,17 +1756,20 @@ "CreateProjectRequest$Tags": "

Metadata tags to apply to this project.

", "CreateRecipeJobRequest$Tags": "

Metadata tags to apply to this job.

", "CreateRecipeRequest$Tags": "

Metadata tags to apply to this recipe.

", + "CreateRulesetRequest$Tags": "

Metadata tags to apply to the ruleset.

", "CreateScheduleRequest$Tags": "

Metadata tags to apply to this schedule.

", "Dataset$Tags": "

Metadata tags that have been applied to the dataset.

", "DescribeDatasetResponse$Tags": "

Metadata tags associated with this dataset.

", "DescribeJobResponse$Tags": "

Metadata tags associated with this job.

", "DescribeProjectResponse$Tags": "

Metadata tags associated with this project.

", "DescribeRecipeResponse$Tags": "

Metadata tags associated with this project.

", + "DescribeRulesetResponse$Tags": "

Metadata tags that have been applied to the ruleset.

", "DescribeScheduleResponse$Tags": "

Metadata tags associated with this schedule.

", "Job$Tags": "

Metadata tags that have been applied to the job.

", "ListTagsForResourceResponse$Tags": "

A list of tags associated with the DataBrew resource.

", "Project$Tags": "

Metadata tags that have been applied to the project.

", "Recipe$Tags": "

Metadata tags that have been applied to the recipe.

", + "RulesetItem$Tags": "

Metadata tags that have been applied to the ruleset.

", "Schedule$Tags": "

Metadata tags that have been applied to the schedule.

", "TagResourceRequest$Tags": "

One or more tags to be assigned to the resource.

" } @@ -1598,6 +1796,30 @@ "ConditionExpression$TargetColumn": "

A column to apply this condition to.

" } }, + "Threshold": { + "base": "

The threshold used with a non-aggregate check expression. The non-aggregate check expression will be applied to each row in a specific column. Then the threshold will be used to determine whether the validation succeeds.

", + "refs": { + "Rule$Threshold": "

The threshold used with a non-aggregate check expression. Non-aggregate check expressions will be applied to each row in a specific column, and the threshold will be used to determine whether the validation succeeds.

" + } + }, + "ThresholdType": { + "base": null, + "refs": { + "Threshold$Type": "

The type of a threshold. Used for comparison of an actual count of rows that satisfy the rule to the threshold value.

" + } + }, + "ThresholdUnit": { + "base": null, + "refs": { + "Threshold$Unit": "

Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full sample size used for validation.

" + } + }, + "ThresholdValue": { + "base": null, + "refs": { + "Threshold$Value": "

The value of a threshold.

" + } + }, "Timeout": { "base": null, "refs": { @@ -1675,6 +1897,16 @@ "refs": { } }, + "UpdateRulesetRequest": { + "base": null, + "refs": { + } + }, + "UpdateRulesetResponse": { + "base": null, + "refs": { + } + }, "UpdateScheduleRequest": { "base": null, "refs": { @@ -1685,11 +1917,34 @@ "refs": { } }, + "ValidationConfiguration": { + "base": "

Configuration for data quality validation. Used to select the Rulesets and Validation Mode to be used in the profile job. When ValidationConfiguration is null, the profile job will run without data quality validation.

", + "refs": { + "ValidationConfigurationList$member": null + } + }, + "ValidationConfigurationList": { + "base": null, + "refs": { + "CreateProfileJobRequest$ValidationConfigurations": "

List of validation configurations that are applied to the profile job.

", + "DescribeJobResponse$ValidationConfigurations": "

List of validation configurations that are applied to the profile job.

", + "DescribeJobRunResponse$ValidationConfigurations": "

List of validation configurations that are applied to the profile job.

", + "Job$ValidationConfigurations": "

List of validation configurations that are applied to the profile job.

", + "JobRun$ValidationConfigurations": "

List of validation configurations that are applied to the profile job run.

", + "UpdateProfileJobRequest$ValidationConfigurations": "

List of validation configurations that are applied to the profile job.

" + } + }, "ValidationException": { "base": "

The input parameters for this request failed validation.

", "refs": { } }, + "ValidationMode": { + "base": null, + "refs": { + "ValidationConfiguration$ValidationMode": "

Mode of data quality validation. Default mode is “CHECK_ALL” which verifies all rules defined in the selected ruleset.

" + } + }, "ValueReference": { "base": null, "refs": { @@ -1699,7 +1954,8 @@ "ValuesMap": { "base": null, "refs": { - "FilterExpression$ValuesMap": "

The map of substitution variable names to their values used in this filter expression.

" + "FilterExpression$ValuesMap": "

The map of substitution variable names to their values used in this filter expression.

", + "Rule$SubstitutionMap": "

The map of substitution variable names to their values used in a check expression. Variable names should start with a ':' (colon). Variable values can either be actual values or column names. To differentiate between the two, column names should be enclosed in backticks, for example, \":col1\": \"`Column A`\".

" } }, "ViewFrame": { diff --git a/models/apis/databrew/2017-07-25/paginators-1.json b/models/apis/databrew/2017-07-25/paginators-1.json index d9620b8c4c..90f631fdc2 100644 --- a/models/apis/databrew/2017-07-25/paginators-1.json +++ b/models/apis/databrew/2017-07-25/paginators-1.json @@ -36,6 +36,12 @@ "output_token": "NextToken", "result_key": "Recipes" }, + "ListRulesets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Rulesets" + }, "ListSchedules": { "input_token": "NextToken", "limit_key": "MaxResults", diff --git a/models/apis/forecast/2018-06-26/api-2.json b/models/apis/forecast/2018-06-26/api-2.json index b7680cc3db..7155f2a1ae 100644 --- a/models/apis/forecast/2018-06-26/api-2.json +++ b/models/apis/forecast/2018-06-26/api-2.json @@ -13,6 +13,22 @@ "uid":"forecast-2018-06-26" }, "operations":{ + "CreateAutoPredictor":{ + "name":"CreateAutoPredictor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateAutoPredictorRequest"}, + "output":{"shape":"CreateAutoPredictorResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"} + ] + }, "CreateDataset":{ "name":"CreateDataset", "http":{ @@ -59,6 +75,38 @@ {"shape":"LimitExceededException"} ] }, + "CreateExplainability":{ + "name":"CreateExplainability", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateExplainabilityRequest"}, + "output":{"shape":"CreateExplainabilityResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"} + ] + }, + "CreateExplainabilityExport":{ + "name":"CreateExplainabilityExport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateExplainabilityExportRequest"}, + "output":{"shape":"CreateExplainabilityExportResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"} + ] + }, "CreateForecast":{ "name":"CreateForecast", "http":{ @@ -165,6 +213,34 @@ ], "idempotent":true }, + "DeleteExplainability":{ + "name":"DeleteExplainability", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteExplainabilityRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "idempotent":true + }, + "DeleteExplainabilityExport":{ + "name":"DeleteExplainabilityExport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteExplainabilityExportRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "idempotent":true + }, "DeleteForecast":{ "name":"DeleteForecast", "http":{ @@ -235,6 +311,20 @@ ], "idempotent":true }, + "DescribeAutoPredictor":{ + "name":"DescribeAutoPredictor", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeAutoPredictorRequest"}, + "output":{"shape":"DescribeAutoPredictorResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, "DescribeDataset":{ "name":"DescribeDataset", "http":{ @@ -277,6 +367,34 @@ ], "idempotent":true }, + "DescribeExplainability":{ + "name":"DescribeExplainability", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExplainabilityRequest"}, + "output":{"shape":"DescribeExplainabilityResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, + "DescribeExplainabilityExport":{ + "name":"DescribeExplainabilityExport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeExplainabilityExportRequest"}, + "output":{"shape":"DescribeExplainabilityExportResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, "DescribeForecast":{ "name":"DescribeForecast", "http":{ @@ -388,6 +506,34 @@ ], "idempotent":true }, + "ListExplainabilities":{ + "name":"ListExplainabilities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListExplainabilitiesRequest"}, + "output":{"shape":"ListExplainabilitiesResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidInputException"} + ], + "idempotent":true + }, + "ListExplainabilityExports":{ + "name":"ListExplainabilityExports", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListExplainabilityExportsRequest"}, + "output":{"shape":"ListExplainabilityExportsResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidInputException"} + ], + "idempotent":true + }, "ListForecastExportJobs":{ "name":"ListForecastExportJobs", "http":{ @@ -515,6 +661,20 @@ } }, "shapes":{ + "AdditionalDataset":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"Name"}, + "Configuration":{"shape":"Configuration"} + } + }, + "AdditionalDatasets":{ + "type":"list", + "member":{"shape":"AdditionalDataset"}, + "max":2, + "min":1 + }, "Arn":{ "type":"string", "max":256, @@ -524,6 +684,23 @@ "type":"list", "member":{"shape":"Arn"} }, + "AttributeConfig":{ + "type":"structure", + "required":[ + "AttributeName", + "Transformations" + ], + "members":{ + "AttributeName":{"shape":"Name"}, + "Transformations":{"shape":"Transformations"} + } + }, + "AttributeConfigs":{ + "type":"list", + "member":{"shape":"AttributeConfig"}, + "max":50, + "min":1 + }, "AttributeType":{ "type":"string", "enum":[ @@ -536,7 +713,10 @@ }, "AutoMLOverrideStrategy":{ "type":"string", - "enum":["LatencyOptimized"] + "enum":[ + "LatencyOptimized", + "AccuracyOptimized" + ] }, "Boolean":{"type":"boolean"}, "CategoricalParameterRange":{ @@ -556,6 +736,11 @@ "max":20, "min":1 }, + "Configuration":{ + "type":"map", + "key":{"shape":"Name"}, + "value":{"shape":"Values"} + }, "ContinuousParameterRange":{ "type":"structure", "required":[ @@ -576,6 +761,29 @@ "max":20, "min":1 }, + "CreateAutoPredictorRequest":{ + "type":"structure", + "required":["PredictorName"], + "members":{ + "PredictorName":{"shape":"Name"}, + "ForecastHorizon":{"shape":"Integer"}, + "ForecastTypes":{"shape":"ForecastTypes"}, + "ForecastDimensions":{"shape":"ForecastDimensions"}, + "ForecastFrequency":{"shape":"Frequency"}, + "DataConfig":{"shape":"DataConfig"}, + "EncryptionConfig":{"shape":"EncryptionConfig"}, + "ReferencePredictorArn":{"shape":"Arn"}, + "OptimizationMetric":{"shape":"OptimizationMetric"}, + "ExplainPredictor":{"shape":"Boolean"}, + "Tags":{"shape":"Tags"} + } + }, + "CreateAutoPredictorResponse":{ + "type":"structure", + "members":{ + "PredictorArn":{"shape":"Arn"} + } + }, "CreateDatasetGroupRequest":{ "type":"structure", "required":[ @@ -643,6 +851,51 @@ "DatasetArn":{"shape":"Arn"} } }, + "CreateExplainabilityExportRequest":{ + "type":"structure", + "required":[ + "ExplainabilityExportName", + "ExplainabilityArn", + "Destination" + ], + "members":{ + "ExplainabilityExportName":{"shape":"Name"}, + "ExplainabilityArn":{"shape":"Arn"}, + "Destination":{"shape":"DataDestination"}, + "Tags":{"shape":"Tags"} + } + }, + "CreateExplainabilityExportResponse":{ + "type":"structure", + "members":{ + "ExplainabilityExportArn":{"shape":"Arn"} + } + }, + "CreateExplainabilityRequest":{ + "type":"structure", + "required":[ + "ExplainabilityName", + "ResourceArn", + "ExplainabilityConfig" + ], + "members":{ + "ExplainabilityName":{"shape":"Name"}, + "ResourceArn":{"shape":"Arn"}, + "ExplainabilityConfig":{"shape":"ExplainabilityConfig"}, + "DataSource":{"shape":"DataSource"}, + "Schema":{"shape":"Schema"}, + "EnableVisualization":{"shape":"Boolean"}, + "StartDateTime":{"shape":"LocalDateTime"}, + "EndDateTime":{"shape":"LocalDateTime"}, + "Tags":{"shape":"Tags"} + } + }, + "CreateExplainabilityResponse":{ + "type":"structure", + "members":{ + "ExplainabilityArn":{"shape":"Arn"} + } + }, "CreateForecastExportJobRequest":{ "type":"structure", "required":[ @@ -734,6 +987,15 @@ "PredictorArn":{"shape":"Arn"} } }, + "DataConfig":{ + "type":"structure", + "required":["DatasetGroupArn"], + "members":{ + "DatasetGroupArn":{"shape":"Arn"}, + "AttributeConfigs":{"shape":"AttributeConfigs"}, + "AdditionalDatasets":{"shape":"AdditionalDatasets"} + } + }, "DataDestination":{ "type":"structure", "required":["S3Config"], @@ -821,6 +1083,20 @@ "DatasetArn":{"shape":"Arn"} } }, + "DeleteExplainabilityExportRequest":{ + "type":"structure", + "required":["ExplainabilityExportArn"], + "members":{ + "ExplainabilityExportArn":{"shape":"Arn"} + } + }, + "DeleteExplainabilityRequest":{ + "type":"structure", + "required":["ExplainabilityArn"], + "members":{ + "ExplainabilityArn":{"shape":"Arn"} + } + }, "DeleteForecastExportJobRequest":{ "type":"structure", "required":["ForecastExportJobArn"], @@ -856,6 +1132,34 @@ "ResourceArn":{"shape":"Arn"} } }, + "DescribeAutoPredictorRequest":{ + "type":"structure", + "required":["PredictorArn"], + "members":{ + "PredictorArn":{"shape":"Arn"} + } + }, + "DescribeAutoPredictorResponse":{ + "type":"structure", + "members":{ + "PredictorArn":{"shape":"Arn"}, + "PredictorName":{"shape":"Name"}, + "ForecastHorizon":{"shape":"Integer"}, + "ForecastTypes":{"shape":"ForecastTypes"}, + "ForecastFrequency":{"shape":"Frequency"}, + "DatasetImportJobArns":{"shape":"ArnList"}, + "DataConfig":{"shape":"DataConfig"}, + "EncryptionConfig":{"shape":"EncryptionConfig"}, + "ReferencePredictorSummary":{"shape":"ReferencePredictorSummary"}, + "EstimatedTimeRemainingInMinutes":{"shape":"Long"}, + "Status":{"shape":"Status"}, + "Message":{"shape":"Message"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModificationTime":{"shape":"Timestamp"}, + "OptimizationMetric":{"shape":"OptimizationMetric"}, + "ExplainabilityInfo":{"shape":"ExplainabilityInfo"} + } + }, "DescribeDatasetGroupRequest":{ "type":"structure", "required":["DatasetGroupArn"], @@ -924,6 +1228,52 @@ "LastModificationTime":{"shape":"Timestamp"} } }, + "DescribeExplainabilityExportRequest":{ + "type":"structure", + "required":["ExplainabilityExportArn"], + "members":{ + "ExplainabilityExportArn":{"shape":"Arn"} + } + }, + "DescribeExplainabilityExportResponse":{ + "type":"structure", + "members":{ + "ExplainabilityExportArn":{"shape":"Arn"}, + "ExplainabilityExportName":{"shape":"Name"}, + "ExplainabilityArn":{"shape":"Arn"}, + "Destination":{"shape":"DataDestination"}, + "Message":{"shape":"Message"}, + "Status":{"shape":"Status"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModificationTime":{"shape":"Timestamp"} + } + }, + "DescribeExplainabilityRequest":{ + "type":"structure", + "required":["ExplainabilityArn"], + "members":{ + "ExplainabilityArn":{"shape":"Arn"} + } + }, + "DescribeExplainabilityResponse":{ + "type":"structure", + "members":{ + "ExplainabilityArn":{"shape":"Arn"}, + "ExplainabilityName":{"shape":"Name"}, + "ResourceArn":{"shape":"Arn"}, + "ExplainabilityConfig":{"shape":"ExplainabilityConfig"}, + "EnableVisualization":{"shape":"Boolean"}, + "DataSource":{"shape":"DataSource"}, + "Schema":{"shape":"Schema"}, + "StartDateTime":{"shape":"LocalDateTime"}, + "EndDateTime":{"shape":"LocalDateTime"}, + "EstimatedTimeRemainingInMinutes":{"shape":"Long"}, + "Message":{"shape":"Message"}, + "Status":{"shape":"Status"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModificationTime":{"shape":"Timestamp"} + } + }, "DescribeForecastExportJobRequest":{ "type":"structure", "required":["ForecastExportJobArn"], @@ -999,6 +1349,7 @@ "PredictorArn":{"shape":"Name"}, "PredictorName":{"shape":"Name"}, "AlgorithmArn":{"shape":"Arn"}, + "AutoMLAlgorithmArns":{"shape":"ArnList"}, "ForecastHorizon":{"shape":"Integer"}, "ForecastTypes":{"shape":"ForecastTypes"}, "PerformAutoML":{"shape":"Boolean"}, @@ -1012,8 +1363,8 @@ "EncryptionConfig":{"shape":"EncryptionConfig"}, "PredictorExecutionDetails":{"shape":"PredictorExecutionDetails"}, "EstimatedTimeRemainingInMinutes":{"shape":"Long"}, + "IsAutoPredictor":{"shape":"Boolean"}, "DatasetImportJobArns":{"shape":"ArnList"}, - "AutoMLAlgorithmArns":{"shape":"ArnList"}, "Status":{"shape":"Status"}, "Message":{"shape":"Message"}, "CreationTime":{"shape":"Timestamp"}, @@ -1081,6 +1432,57 @@ "COMPUTED" ] }, + "Explainabilities":{ + "type":"list", + "member":{"shape":"ExplainabilitySummary"} + }, + "ExplainabilityConfig":{ + "type":"structure", + "required":[ + "TimeSeriesGranularity", + "TimePointGranularity" + ], + "members":{ + "TimeSeriesGranularity":{"shape":"TimeSeriesGranularity"}, + "TimePointGranularity":{"shape":"TimePointGranularity"} + } + }, + "ExplainabilityExportSummary":{ + "type":"structure", + "members":{ + "ExplainabilityExportArn":{"shape":"Arn"}, + "ExplainabilityExportName":{"shape":"Name"}, + "Destination":{"shape":"DataDestination"}, + "Status":{"shape":"Status"}, + "Message":{"shape":"ErrorMessage"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModificationTime":{"shape":"Timestamp"} + } + }, + "ExplainabilityExports":{ + "type":"list", + "member":{"shape":"ExplainabilityExportSummary"} + }, + "ExplainabilityInfo":{ + "type":"structure", + "members":{ + "ExplainabilityArn":{"shape":"Arn"}, + "Status":{"shape":"Status"} + } + }, + "ExplainabilitySummary":{ + "type":"structure", + "members":{ + "ExplainabilityArn":{"shape":"Arn"}, + "ExplainabilityName":{"shape":"Name"}, + "ResourceArn":{"shape":"Arn"}, + "ExplainabilityConfig":{"shape":"ExplainabilityConfig"}, + "Status":{"shape":"Status"}, + "Message":{"shape":"Message"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModificationTime":{"shape":"Timestamp"} + } + }, "Featurization":{ "type":"structure", "required":["AttributeName"], @@ -1161,7 +1563,7 @@ "ForecastDimensions":{ "type":"list", "member":{"shape":"Name"}, - "max":5, + "max":10, "min":1 }, "ForecastExportJobSummary":{ @@ -1186,6 +1588,7 @@ "ForecastArn":{"shape":"Arn"}, "ForecastName":{"shape":"Name"}, "PredictorArn":{"shape":"String"}, + "CreatedUsingAutoPredictor":{"shape":"Boolean"}, "DatasetGroupArn":{"shape":"String"}, "Status":{"shape":"Status"}, "Message":{"shape":"ErrorMessage"}, @@ -1195,6 +1598,8 @@ }, "ForecastType":{ "type":"string", + "max":4, + "min":2, "pattern":"(^0?\\.\\d\\d?$|^mean$)" }, "ForecastTypes":{ @@ -1209,6 +1614,8 @@ }, "Frequency":{ "type":"string", + "max":5, + "min":1, "pattern":"^Y|M|W|D|H|30min|15min|10min|5min|1min$" }, "GeolocationFormat":{ @@ -1227,6 +1634,7 @@ "type":"structure", "members":{ "PredictorEvaluationResults":{"shape":"PredictorEvaluationResults"}, + "IsAutoPredictor":{"shape":"Boolean"}, "AutoMLOverrideStrategy":{"shape":"AutoMLOverrideStrategy"}, "OptimizationMetric":{"shape":"OptimizationMetric"} } @@ -1335,6 +1743,36 @@ "NextToken":{"shape":"NextToken"} } }, + "ListExplainabilitiesRequest":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"}, + "Filters":{"shape":"Filters"} + } + }, + "ListExplainabilitiesResponse":{ + "type":"structure", + "members":{ + "Explainabilities":{"shape":"Explainabilities"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListExplainabilityExportsRequest":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"}, + "Filters":{"shape":"Filters"} + } + }, + "ListExplainabilityExportsResponse":{ + "type":"structure", + "members":{ + "ExplainabilityExports":{"shape":"ExplainabilityExports"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListForecastExportJobsRequest":{ "type":"structure", "members":{ @@ -1408,6 +1846,11 @@ "Tags":{"shape":"Tags"} } }, + "LocalDateTime":{ + "type":"string", + "max":19, + "pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$" + }, "Long":{"type":"long"}, "MaxResults":{ "type":"integer", @@ -1437,7 +1880,8 @@ "NextToken":{ "type":"string", "max":3000, - "min":1 + "min":1, + "pattern":".+" }, "OptimizationMetric":{ "type":"string", @@ -1512,6 +1956,8 @@ "PredictorArn":{"shape":"Arn"}, "PredictorName":{"shape":"Name"}, "DatasetGroupArn":{"shape":"Arn"}, + "IsAutoPredictor":{"shape":"Boolean"}, + "ReferencePredictorSummary":{"shape":"ReferencePredictorSummary"}, "Status":{"shape":"Status"}, "Message":{"shape":"ErrorMessage"}, "CreationTime":{"shape":"Timestamp"}, @@ -1522,6 +1968,13 @@ "type":"list", "member":{"shape":"PredictorSummary"} }, + "ReferencePredictorSummary":{ + "type":"structure", + "members":{ + "Arn":{"shape":"Arn"}, + "State":{"shape":"State"} + } + }, "ResourceAlreadyExistsException":{ "type":"structure", "members":{ @@ -1557,6 +2010,8 @@ }, "S3Path":{ "type":"string", + "max":4096, + "min":7, "pattern":"^s3://[a-z0-9].+$" }, "ScalingType":{ @@ -1587,6 +2042,13 @@ "max":100, "min":1 }, + "State":{ + "type":"string", + "enum":[ + "Active", + "Deleted" + ] + }, "Statistics":{ "type":"structure", "members":{ @@ -1707,6 +2169,20 @@ "type":"list", "member":{"shape":"WindowSummary"} }, + "TimePointGranularity":{ + "type":"string", + "enum":[ + "ALL", + "SPECIFIC" + ] + }, + "TimeSeriesGranularity":{ + "type":"string", + "enum":[ + "ALL", + "SPECIFIC" + ] + }, "TimeZone":{ "type":"string", "max":256, @@ -1725,6 +2201,13 @@ "max":100, "min":0 }, + "Transformations":{ + "type":"map", + "key":{"shape":"Name"}, + "value":{"shape":"Value"}, + "max":20, + "min":1 + }, "UntagResourceRequest":{ "type":"structure", "required":[ diff --git a/models/apis/forecast/2018-06-26/docs-2.json b/models/apis/forecast/2018-06-26/docs-2.json index e57b610042..7fd37ffdc9 100644 --- a/models/apis/forecast/2018-06-26/docs-2.json +++ b/models/apis/forecast/2018-06-26/docs-2.json @@ -2,32 +2,42 @@ "version": "2.0", "service": "

Provides APIs for creating and managing Amazon Forecast resources.

", "operations": { + "CreateAutoPredictor": "

Creates an Amazon Forecast predictor.

Amazon Forecast creates predictors with AutoPredictor, which involves applying the optimal combination of algorithms to each time series in your datasets. You can use CreateAutoPredictor to create new predictors or upgrade/retrain existing predictors.

Creating new predictors

The following parameters are required when creating a new predictor:

When creating a new predictor, do not specify a value for ReferencePredictorArn.

Upgrading and retraining predictors

The following parameters are required when retraining or upgrading a predictor:

When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn and PredictorName.

", "CreateDataset": "

Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:

After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see howitworks-datasets-groups.

To get a list of all your datasets, use the ListDatasets operation.

For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.

The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to get the status.

", "CreateDatasetGroup": "

Creates a dataset group, which holds a collection of related datasets. You can add datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.

After creating a dataset group and adding datasets, you use the dataset group when you create a predictor. For more information, see howitworks-datasets-groups.

To get a list of all your datasets groups, use the ListDatasetGroups operation.

The Status of a dataset group must be ACTIVE before you can use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.

", "CreateDatasetImportJob": "

Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.

You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see aws-forecast-iam-roles.

The training data must be in CSV format. The delimiter must be a comma (,).

You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.

Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import.

To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.

", + "CreateExplainability": "

Explainability is only available for Forecasts and Predictors generated from an AutoPredictor (CreateAutoPredictor)

Creates an Amazon Forecast Explainability.

Explainability helps you better understand how the attributes in your datasets impact forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative impact of each attribute and determine whether they increase or decrease forecast values.

To enable Forecast Explainability, your predictor must include at least one of the following: related time series, item metadata, or additional datasets like Holidays and the Weather Index.

CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive aggregated Impact scores for all time series and time points in your datasets, provide a Predictor ARN. To receive Impact scores for specific time series and time points, provide a Forecast ARN.

CreateExplainability with a Predictor ARN

You can only have one Explainability resource per predictor. If you already enabled ExplainPredictor in CreateAutoPredictor, that predictor already has an Explainability resource.

The following parameters are required when providing a Predictor ARN:

Do not specify a value for the following parameters:

CreateExplainability with a Forecast ARN

You can specify a maximum of 50 time series and 1500 time points.

The following parameters are required when providing a Predictor ARN:

If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the following:

If you set TimePointGranularity to “SPECIFIC”, you must also provide the following:

", + "CreateExplainabilityExport": "

Exports an Explainability resource created by the CreateExplainability operation. Exported files are exported to an Amazon Simple Storage Service (Amazon S3) bucket.

You must specify a DataDestination object that includes an Amazon S3 bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

The Status of the export job must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport operation.

", "CreateForecast": "

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast.

To get a list of all your forecasts, use the ListForecasts operation.

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.

For more information, see howitworks-forecast.

The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status.

", "CreateForecastExportJob": "

Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>

where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

For more information, see howitworks-forecast.

To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.

The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.

", - "CreatePredictor": "

Creates an Amazon Forecast predictor.

In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.

Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified dataset group. You can then generate a forecast using the CreateForecast operation.

To see the evaluation metrics, use the GetAccuracyMetrics operation.

You can specify a featurization configuration to fill and aggregate the data fields in the TARGET_TIME_SERIES dataset to improve model training. For more information, see FeaturizationConfig.

For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.

By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes.

AutoML

If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the objective function, set PerformAutoML to true. The objective function is defined as the mean of the weighted losses over the forecast types. By default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult.

When AutoML is enabled, the following properties are disallowed:

To get a list of all of your predictors, use the ListPredictors operation.

Before you can use the predictor to create a forecast, the Status of the predictor must be ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor operation.

", + "CreatePredictor": "

This operation creates a legacy predictor that does not include all the predictor functionalities provided by Amazon Forecast. To create a predictor that is compatible with all aspects of Forecast, use CreateAutoPredictor.

Creates an Amazon Forecast predictor.

In the request, provide a dataset group and either specify an algorithm or let Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can override algorithm-specific hyperparameters.

Amazon Forecast uses the algorithm to train a predictor using the latest version of the datasets in the specified dataset group. You can then generate a forecast using the CreateForecast operation.

To see the evaluation metrics, use the GetAccuracyMetrics operation.

You can specify a featurization configuration to fill and aggregate the data fields in the TARGET_TIME_SERIES dataset to improve model training. For more information, see FeaturizationConfig.

For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction. Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.

By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9 (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by setting the ForecastTypes.

AutoML

If you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the objective function, set PerformAutoML to true. The objective function is defined as the mean of the weighted losses over the forecast types. By default, these are the p10, p50, and p90 quantile losses. For more information, see EvaluationResult.

When AutoML is enabled, the following properties are disallowed:

To get a list of all of your predictors, use the ListPredictors operation.

Before you can use the predictor to create a forecast, the Status of the predictor must be ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor operation.

", "CreatePredictorBacktestExportJob": "

Exports backtest forecasts and accuracy metrics generated by the CreatePredictor operation. Two folders containing CSV files are exported to your specified S3 bucket.

The export file names will match the following conventions:

<ExportJobName>_<ExportTimestamp>_<PartNumber>.csv

The <ExportTimestamp> component is in Java SimpleDate format (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an Amazon S3 bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

The Status of the export job must be ACTIVE before you can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.

", "DeleteDataset": "

Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset operation.

Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the operation, omitting the deleted dataset's ARN.

", "DeleteDatasetGroup": "

Deletes a dataset group created using the CreateDatasetGroup operation. You can only delete dataset groups that have a status of ACTIVE, CREATE_FAILED, or UPDATE_FAILED. To get the status, use the DescribeDatasetGroup operation.

This operation deletes only the dataset group, not the datasets in the group.

", "DeleteDatasetImportJob": "

Deletes a dataset import job created using the CreateDatasetImportJob operation. You can delete only dataset import jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeDatasetImportJob operation.

", + "DeleteExplainability": "

Deletes an Explainability resource.

You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeExplainability operation.

", + "DeleteExplainabilityExport": "

Deletes an Explainability export job.

", "DeleteForecast": "

Deletes a forecast created using the CreateForecast operation. You can delete only forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecast operation.

You can't delete a forecast while it is being exported. After a forecast is deleted, you can no longer query the forecast.

", "DeleteForecastExportJob": "

Deletes a forecast export job created using the CreateForecastExportJob operation. You can delete only export jobs that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeForecastExportJob operation.

", "DeletePredictor": "

Deletes a predictor created using the CreatePredictor operation. You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor operation.

", "DeletePredictorBacktestExportJob": "

Deletes a predictor backtest export job.

", "DeleteResourceTree": "

Deletes an entire resource tree. This operation will delete the parent resource and its child resources.

Child resources are resources that were created from another resource. For example, when a forecast is generated from a predictor, the forecast is the child resource and the predictor is the parent resource.

Amazon Forecast resources possess the following parent-child resource hierarchies:

DeleteResourceTree will only delete Amazon Forecast resources, and will not delete datasets or exported files stored in Amazon S3.

", + "DescribeAutoPredictor": "

Describes a predictor created using the CreateAutoPredictor operation.

", "DescribeDataset": "

Describes an Amazon Forecast dataset created using the CreateDataset operation.

In addition to listing the parameters specified in the CreateDataset request, this operation includes the following dataset properties:

", "DescribeDatasetGroup": "

Describes a dataset group created using the CreateDatasetGroup operation.

In addition to listing the parameters provided in the CreateDatasetGroup request, this operation includes the following properties:

", "DescribeDatasetImportJob": "

Describes a dataset import job created using the CreateDatasetImportJob operation.

In addition to listing the parameters provided in the CreateDatasetImportJob request, this operation includes the following properties:

", + "DescribeExplainability": "

Describes an Explainability resource created using the CreateExplainability operation.

", + "DescribeExplainabilityExport": "

Describes an Explainability export created using the CreateExplainabilityExport operation.

", "DescribeForecast": "

Describes a forecast created using the CreateForecast operation.

In addition to listing the properties provided in the CreateForecast request, this operation lists the following properties:

", "DescribeForecastExportJob": "

Describes a forecast export job created using the CreateForecastExportJob operation.

In addition to listing the properties provided by the user in the CreateForecastExportJob request, this operation lists the following properties:

", - "DescribePredictor": "

Describes a predictor created using the CreatePredictor operation.

In addition to listing the properties provided in the CreatePredictor request, this operation lists the following properties:

", + "DescribePredictor": "

This operation is only valid for legacy predictors created with CreatePredictor. If you are not using a legacy predictor, use DescribeAutoPredictor.

To upgrade a legacy predictor to AutoPredictor, see Upgrading to AutoPredictor.

Describes a predictor created using the CreatePredictor operation.

In addition to listing the properties provided in the CreatePredictor request, this operation lists the following properties:

", "DescribePredictorBacktestExportJob": "

Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.

In addition to listing the properties provided by the user in the CreatePredictorBacktestExportJob request, this operation lists the following properties:

", "GetAccuracyMetrics": "

Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation. Use metrics to see how well the model performed and to decide whether to use the predictor to generate a forecast. For more information, see Predictor Metrics.

This operation generates metrics for each backtest window that was evaluated. The number of backtest windows (NumberOfBacktestWindows) is specified using the EvaluationParameters object, which is optionally included in the CreatePredictor request. If NumberOfBacktestWindows isn't specified, the number defaults to one.

The parameters of the filling method determine which items contribute to the metrics. If you want all items to contribute, specify zero. If you want only those items that have complete data in the range being evaluated to contribute, specify nan. For more information, see FeaturizationMethod.

Before you can get accuracy metrics, the Status of the predictor must be ACTIVE, signifying that training has completed. To get the status, use the DescribePredictor operation.

", "ListDatasetGroups": "

Returns a list of dataset groups created using the CreateDatasetGroup operation. For each dataset group, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the dataset group ARN with the DescribeDatasetGroup operation.

", "ListDatasetImportJobs": "

Returns a list of dataset import jobs created using the CreateDatasetImportJob operation. For each import job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribeDatasetImportJob operation. You can filter the list by providing an array of Filter objects.

", "ListDatasets": "

Returns a list of datasets created using the CreateDataset operation. For each dataset, a summary of its properties, including its Amazon Resource Name (ARN), is returned. To retrieve the complete set of properties, use the ARN with the DescribeDataset operation.

", + "ListExplainabilities": "

Returns a list of Explainability resources created using the CreateExplainability operation. This operation returns a summary for each Explainability. You can filter the list using an array of Filter objects.

To retrieve the complete set of properties for a particular Explainability resource, use the ARN with the DescribeExplainability operation.

", + "ListExplainabilityExports": "

Returns a list of Explainability exports created using the CreateExplainabilityExport operation. This operation returns a summary for each Explainability export. You can filter the list using an array of Filter objects.

To retrieve the complete set of properties for a particular Explainability export, use the ARN with the DescribeExplainability operation.

", "ListForecastExportJobs": "

Returns a list of forecast export jobs created using the CreateForecastExportJob operation. For each forecast export job, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, use the ARN with the DescribeForecastExportJob operation. You can filter the list using an array of Filter objects.

", "ListForecasts": "

Returns a list of forecasts created using the CreateForecast operation. For each forecast, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). To retrieve the complete set of properties, specify the ARN with the DescribeForecast operation. You can filter the list using an array of Filter objects.

", "ListPredictorBacktestExportJobs": "

Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a summary for each backtest export job. You can filter the list using an array of Filter objects.

To retrieve the complete set of properties for a particular backtest export job, use the ARN with the DescribePredictorBacktestExportJob operation.

", @@ -39,14 +49,32 @@ "UpdateDatasetGroup": "

Replaces the datasets in a dataset group with the specified datasets.

The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor. Use the DescribeDatasetGroup operation to get the status.

" }, "shapes": { + "AdditionalDataset": { + "base": "

Describes an additional dataset. This object is part of the DataConfig object. Forecast supports the Weather Index and Holidays additional datasets.

Weather Index

The Amazon Forecast Weather Index is a built-in dataset that incorporates historical and projected weather information into your model. The Weather Index supplements your datasets with over two years of historical weather data and up to 14 days of projected weather data. For more information, see Amazon Forecast Weather Index.

Holidays

Holidays is a built-in dataset that incorporates national holiday information into your model. It provides native support for the holiday calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more information, see Holidays Featurization.

", + "refs": { + "AdditionalDatasets$member": null + } + }, + "AdditionalDatasets": { + "base": null, + "refs": { + "DataConfig$AdditionalDatasets": "

Additional built-in datasets like Holidays and the Weather Index.

" + } + }, "Arn": { "base": null, "refs": { "ArnList$member": null, + "CreateAutoPredictorRequest$ReferencePredictorArn": "

The ARN of the predictor to retrain or upgrade. This parameter is only used when retraining or upgrading a predictor. When creating a new predictor, do not specify a value for this parameter.

When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn and PredictorName. The value for PredictorName must be a unique predictor name.

", + "CreateAutoPredictorResponse$PredictorArn": "

The Amazon Resource Name (ARN) of the predictor.

", "CreateDatasetGroupResponse$DatasetGroupArn": "

The Amazon Resource Name (ARN) of the dataset group.

", "CreateDatasetImportJobRequest$DatasetArn": "

The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want to import data to.

", "CreateDatasetImportJobResponse$DatasetImportJobArn": "

The Amazon Resource Name (ARN) of the dataset import job.

", "CreateDatasetResponse$DatasetArn": "

The Amazon Resource Name (ARN) of the dataset.

", + "CreateExplainabilityExportRequest$ExplainabilityArn": "

The Amazon Resource Name (ARN) of the Explainability to export.

", + "CreateExplainabilityExportResponse$ExplainabilityExportArn": "

The Amazon Resource Name (ARN) of the export.

", + "CreateExplainabilityRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.

", + "CreateExplainabilityResponse$ExplainabilityArn": "

The Amazon Resource Name (ARN) of the Explainability.

", "CreateForecastExportJobRequest$ForecastArn": "

The Amazon Resource Name (ARN) of the forecast that you want to export.

", "CreateForecastExportJobResponse$ForecastExportJobArn": "

The Amazon Resource Name (ARN) of the export job.

", "CreateForecastRequest$PredictorArn": "

The Amazon Resource Name (ARN) of the predictor to use to generate the forecast.

", @@ -55,17 +83,22 @@ "CreatePredictorBacktestExportJobResponse$PredictorBacktestExportJobArn": "

The Amazon Resource Name (ARN) of the predictor backtest export job that you want to export.

", "CreatePredictorRequest$AlgorithmArn": "

The Amazon Resource Name (ARN) of the algorithm to use for model training. Required if PerformAutoML is not set to true.

Supported algorithms:

", "CreatePredictorResponse$PredictorArn": "

The Amazon Resource Name (ARN) of the predictor.

", + "DataConfig$DatasetGroupArn": "

The ARN of the dataset group used to train the predictor.

", "DatasetGroupSummary$DatasetGroupArn": "

The Amazon Resource Name (ARN) of the dataset group.

", "DatasetImportJobSummary$DatasetImportJobArn": "

The Amazon Resource Name (ARN) of the dataset import job.

", "DatasetSummary$DatasetArn": "

The Amazon Resource Name (ARN) of the dataset.

", "DeleteDatasetGroupRequest$DatasetGroupArn": "

The Amazon Resource Name (ARN) of the dataset group to delete.

", "DeleteDatasetImportJobRequest$DatasetImportJobArn": "

The Amazon Resource Name (ARN) of the dataset import job to delete.

", "DeleteDatasetRequest$DatasetArn": "

The Amazon Resource Name (ARN) of the dataset to delete.

", + "DeleteExplainabilityExportRequest$ExplainabilityExportArn": "

The Amazon Resource Name (ARN) of the Explainability export to delete.

", + "DeleteExplainabilityRequest$ExplainabilityArn": "

The Amazon Resource Name (ARN) of the Explainability resource to delete.

", "DeleteForecastExportJobRequest$ForecastExportJobArn": "

The Amazon Resource Name (ARN) of the forecast export job to delete.

", "DeleteForecastRequest$ForecastArn": "

The Amazon Resource Name (ARN) of the forecast to delete.

", "DeletePredictorBacktestExportJobRequest$PredictorBacktestExportJobArn": "

The Amazon Resource Name (ARN) of the predictor backtest export job to delete.

", "DeletePredictorRequest$PredictorArn": "

The Amazon Resource Name (ARN) of the predictor to delete.

", "DeleteResourceTreeRequest$ResourceArn": "

The Amazon Resource Name (ARN) of the parent resource to delete. All child resources of the parent resource will also be deleted.

", + "DescribeAutoPredictorRequest$PredictorArn": "

The Amazon Resource Name (ARN) of the predictor.

", + "DescribeAutoPredictorResponse$PredictorArn": "

The Amazon Resource Name (ARN) of the predictor

", "DescribeDatasetGroupRequest$DatasetGroupArn": "

The Amazon Resource Name (ARN) of the dataset group.

", "DescribeDatasetGroupResponse$DatasetGroupArn": "

The ARN of the dataset group.

", "DescribeDatasetImportJobRequest$DatasetImportJobArn": "

The Amazon Resource Name (ARN) of the dataset import job.

", @@ -73,6 +106,12 @@ "DescribeDatasetImportJobResponse$DatasetArn": "

The Amazon Resource Name (ARN) of the dataset that the training data was imported to.

", "DescribeDatasetRequest$DatasetArn": "

The Amazon Resource Name (ARN) of the dataset.

", "DescribeDatasetResponse$DatasetArn": "

The Amazon Resource Name (ARN) of the dataset.

", + "DescribeExplainabilityExportRequest$ExplainabilityExportArn": "

The Amazon Resource Name (ARN) of the Explainability export.

", + "DescribeExplainabilityExportResponse$ExplainabilityExportArn": "

The Amazon Resource Name (ARN) of the Explainability export.

", + "DescribeExplainabilityExportResponse$ExplainabilityArn": "

The Amazon Resource Name (ARN) of the Explainability.

", + "DescribeExplainabilityRequest$ExplainabilityArn": "

The Amazon Resource Name (ARN) of the Explaianability to describe.

", + "DescribeExplainabilityResponse$ExplainabilityArn": "

The Amazon Resource Name (ARN) of the Explainability.

", + "DescribeExplainabilityResponse$ResourceArn": "

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability resource.

", "DescribeForecastExportJobRequest$ForecastExportJobArn": "

The Amazon Resource Name (ARN) of the forecast export job.

", "DescribeForecastExportJobResponse$ForecastExportJobArn": "

The ARN of the forecast export job.

", "DescribeForecastExportJobResponse$ForecastArn": "

The Amazon Resource Name (ARN) of the exported forecast.

", @@ -87,6 +126,10 @@ "DescribePredictorResponse$AlgorithmArn": "

The Amazon Resource Name (ARN) of the algorithm used for model training.

", "EncryptionConfig$RoleArn": "

The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

", "EvaluationResult$AlgorithmArn": "

The Amazon Resource Name (ARN) of the algorithm that was evaluated.

", + "ExplainabilityExportSummary$ExplainabilityExportArn": "

The Amazon Resource Name (ARN) of the Explainability export.

", + "ExplainabilityInfo$ExplainabilityArn": null, + "ExplainabilitySummary$ExplainabilityArn": "

The Amazon Resource Name (ARN) of the Explainability.

", + "ExplainabilitySummary$ResourceArn": "

The Amazon Resource Name (ARN) of the Predictor or Forecast used to create the Explainability.

", "Filter$Value": "

The value to match.

", "ForecastExportJobSummary$ForecastExportJobArn": "

The Amazon Resource Name (ARN) of the forecast export job.

", "ForecastSummary$ForecastArn": "

The ARN of the forecast.

", @@ -97,6 +140,7 @@ "PredictorExecution$AlgorithmArn": "

The ARN of the algorithm used to test the predictor.

", "PredictorSummary$PredictorArn": "

The ARN of the predictor.

", "PredictorSummary$DatasetGroupArn": "

The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.

", + "ReferencePredictorSummary$Arn": "

The ARN of the reference predictor.

", "S3Config$RoleArn": "

The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket or files. If you provide a value for the KMSKeyArn key, the role must allow access to the key.

Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an InvalidInputException error.

", "StopResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs are DatasetImportJobArn, PredictorArn, PredictorBacktestExportJobArn, ForecastArn, and ForecastExportJobArn.

", "TagResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast export jobs.

", @@ -108,12 +152,25 @@ "base": null, "refs": { "CreateDatasetGroupRequest$DatasetArns": "

An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.

", + "DescribeAutoPredictorResponse$DatasetImportJobArns": "

An array of the ARNs of the dataset import jobs used to import training data for the predictor.

", "DescribeDatasetGroupResponse$DatasetArns": "

An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset group.

", - "DescribePredictorResponse$DatasetImportJobArns": "

An array of the ARNs of the dataset import jobs used to import training data for the predictor.

", "DescribePredictorResponse$AutoMLAlgorithmArns": "

When PerformAutoML is specified, the ARN of the chosen algorithm.

", + "DescribePredictorResponse$DatasetImportJobArns": "

An array of the ARNs of the dataset import jobs used to import training data for the predictor.

", "UpdateDatasetGroupRequest$DatasetArns": "

An array of the Amazon Resource Names (ARNs) of the datasets to add to the dataset group.

" } }, + "AttributeConfig": { + "base": "

Provides information about the method used to transform attributes.

The following is an example using the RETAIL domain:

{

\"AttributeName\": \"demand\",

\"Transformations\": {\"aggregation\": \"sum\", \"middlefill\": \"zero\", \"backfill\": \"zero\"}

}

", + "refs": { + "AttributeConfigs$member": null + } + }, + "AttributeConfigs": { + "base": null, + "refs": { + "DataConfig$AttributeConfigs": "

Aggregation and filling options for attributes in your dataset group.

" + } + }, "AttributeType": { "base": null, "refs": { @@ -131,10 +188,17 @@ "Boolean": { "base": null, "refs": { + "CreateAutoPredictorRequest$ExplainPredictor": null, + "CreateExplainabilityRequest$EnableVisualization": "

Create an Expainability visualization that is viewable within the AWS console.

", "CreatePredictorRequest$PerformAutoML": "

Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates the algorithms it provides and chooses the best algorithm and configuration for your training dataset.

The default value is false. In this case, you are required to specify an algorithm.

Set PerformAutoML to true to have Amazon Forecast perform AutoML. This is a good option if you aren't sure which algorithm is suitable for your training data. In this case, PerformHPO must be false.

", "CreatePredictorRequest$PerformHPO": "

Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter values for your training data. The process of performing HPO is known as running a hyperparameter tuning job.

The default value is false. In this case, Amazon Forecast uses default hyperparameter values from the chosen algorithm.

To override the default values, set PerformHPO to true and, optionally, supply the HyperParameterTuningJobConfig object. The tuning job specifies a metric to optimize, which hyperparameters participate in tuning, and the valid range for each tunable hyperparameter. In this case, you are required to specify an algorithm and PerformAutoML must be false.

The following algorithms support HPO:

", + "DescribeExplainabilityResponse$EnableVisualization": "

Whether the visualization was enabled for the Explainability resource.

", "DescribePredictorResponse$PerformAutoML": "

Whether the predictor is set to perform AutoML.

", - "DescribePredictorResponse$PerformHPO": "

Whether the predictor is set to perform hyperparameter optimization (HPO).

" + "DescribePredictorResponse$PerformHPO": "

Whether the predictor is set to perform hyperparameter optimization (HPO).

", + "DescribePredictorResponse$IsAutoPredictor": "

Whether the predictor was created with CreateAutoPredictor.

", + "ForecastSummary$CreatedUsingAutoPredictor": null, + "GetAccuracyMetricsResponse$IsAutoPredictor": "

Whether the predictor was created with CreateAutoPredictor.

", + "PredictorSummary$IsAutoPredictor": "

Whether AutoPredictor was used to create the predictor.

" } }, "CategoricalParameterRange": { @@ -149,6 +213,12 @@ "ParameterRanges$CategoricalParameterRanges": "

Specifies the tunable range for each categorical hyperparameter.

" } }, + "Configuration": { + "base": null, + "refs": { + "AdditionalDataset$Configuration": "

Weather Index

To enable the Weather Index, do not specify a value for Configuration.

Holidays

To enable Holidays, specify a country with one of the following two-letter country codes:

" + } + }, "ContinuousParameterRange": { "base": "

Specifies a continuous hyperparameter and it's range of tunable values. This object is part of the ParameterRanges object.

", "refs": { @@ -161,6 +231,16 @@ "ParameterRanges$ContinuousParameterRanges": "

Specifies the tunable range for each continuous hyperparameter.

" } }, + "CreateAutoPredictorRequest": { + "base": null, + "refs": { + } + }, + "CreateAutoPredictorResponse": { + "base": null, + "refs": { + } + }, "CreateDatasetGroupRequest": { "base": null, "refs": { @@ -191,6 +271,26 @@ "refs": { } }, + "CreateExplainabilityExportRequest": { + "base": null, + "refs": { + } + }, + "CreateExplainabilityExportResponse": { + "base": null, + "refs": { + } + }, + "CreateExplainabilityRequest": { + "base": null, + "refs": { + } + }, + "CreateExplainabilityResponse": { + "base": null, + "refs": { + } + }, "CreateForecastExportJobRequest": { "base": null, "refs": { @@ -231,13 +331,23 @@ "refs": { } }, + "DataConfig": { + "base": "

The data configuration for your dataset group and any additional datasets.

", + "refs": { + "CreateAutoPredictorRequest$DataConfig": "

The data configuration for your dataset group and any additional datasets.

", + "DescribeAutoPredictorResponse$DataConfig": "

The data configuration for your dataset group and any additional datasets.

" + } + }, "DataDestination": { "base": "

The destination for an export job. Provide an S3 path, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the location, and an AWS Key Management Service (KMS) key (optional).

", "refs": { + "CreateExplainabilityExportRequest$Destination": null, "CreateForecastExportJobRequest$Destination": "

The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an AWS Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

", "CreatePredictorBacktestExportJobRequest$Destination": null, + "DescribeExplainabilityExportResponse$Destination": null, "DescribeForecastExportJobResponse$Destination": "

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

", "DescribePredictorBacktestExportJobResponse$Destination": null, + "ExplainabilityExportSummary$Destination": null, "ForecastExportJobSummary$Destination": "

The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.

", "PredictorBacktestExportJobSummary$Destination": null } @@ -246,8 +356,10 @@ "base": "

The source of your training data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to access the data and, optionally, an AWS Key Management Service (KMS) key. This object is submitted in the CreateDatasetImportJob request.

", "refs": { "CreateDatasetImportJobRequest$DataSource": "

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

If encryption is used, DataSource must include an AWS Key Management Service (KMS) key and the IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must match those specified in the EncryptionConfig parameter of the CreateDataset operation.

", + "CreateExplainabilityRequest$DataSource": null, "DatasetImportJobSummary$DataSource": "

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. The training data must be stored in an Amazon S3 bucket.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

", - "DescribeDatasetImportJobResponse$DataSource": "

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

" + "DescribeDatasetImportJobResponse$DataSource": "

The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data.

If encryption is used, DataSource includes an AWS Key Management Service (KMS) key.

", + "DescribeExplainabilityResponse$DataSource": null } }, "DatasetGroupSummary": { @@ -309,6 +421,16 @@ "refs": { } }, + "DeleteExplainabilityExportRequest": { + "base": null, + "refs": { + } + }, + "DeleteExplainabilityRequest": { + "base": null, + "refs": { + } + }, "DeleteForecastExportJobRequest": { "base": null, "refs": { @@ -334,6 +456,16 @@ "refs": { } }, + "DescribeAutoPredictorRequest": { + "base": null, + "refs": { + } + }, + "DescribeAutoPredictorResponse": { + "base": null, + "refs": { + } + }, "DescribeDatasetGroupRequest": { "base": null, "refs": { @@ -364,6 +496,26 @@ "refs": { } }, + "DescribeExplainabilityExportRequest": { + "base": null, + "refs": { + } + }, + "DescribeExplainabilityExportResponse": { + "base": null, + "refs": { + } + }, + "DescribeExplainabilityRequest": { + "base": null, + "refs": { + } + }, + "DescribeExplainabilityResponse": { + "base": null, + "refs": { + } + }, "DescribeForecastExportJobRequest": { "base": null, "refs": { @@ -435,8 +587,10 @@ "EncryptionConfig": { "base": "

An AWS Key Management Service (KMS) key and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key. You can specify this optional object in the CreateDataset and CreatePredictor requests.

", "refs": { + "CreateAutoPredictorRequest$EncryptionConfig": null, "CreateDatasetRequest$EncryptionConfig": "

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

", "CreatePredictorRequest$EncryptionConfig": "

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

", + "DescribeAutoPredictorResponse$EncryptionConfig": null, "DescribeDatasetResponse$EncryptionConfig": "

The AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

", "DescribePredictorResponse$EncryptionConfig": "

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

" } @@ -446,6 +600,7 @@ "refs": { "DatasetImportJobSummary$Message": "

If an error occurred, an informational message about the error.

", "DescribeForecastResponse$Message": "

If an error occurred, an informational message about the error.

", + "ExplainabilityExportSummary$Message": "

Information about any errors that may have occurred during the Explainability export.

", "ForecastExportJobSummary$Message": "

If an error occurred, an informational message about the error.

", "ForecastSummary$Message": "

If an error occurred, an informational message about the error.

", "InvalidInputException$Message": null, @@ -490,6 +645,44 @@ "WindowSummary$EvaluationType": "

The type of evaluation.

" } }, + "Explainabilities": { + "base": null, + "refs": { + "ListExplainabilitiesResponse$Explainabilities": "

An array of objects that summarize the properties of each Explainability resource.

" + } + }, + "ExplainabilityConfig": { + "base": "

The ExplainabilityConfig data type defines the number of time series and time points included in CreateExplainability.

If you provide a predictor ARN for ResourceArn, you must set both TimePointGranularity and TimeSeriesGranularity to “ALL”. When creating Predictor Explainability, Amazon Forecast considers all time series and time points.

If you provide a forecast ARN for ResourceArn, you can set TimePointGranularity and TimeSeriesGranularity to either “ALL” or “Specific”.

", + "refs": { + "CreateExplainabilityRequest$ExplainabilityConfig": "

The configuration settings that define the granularity of time series and time points for the Explainability.

", + "DescribeExplainabilityResponse$ExplainabilityConfig": "

The configuration settings that define the granularity of time series and time points for the Explainability.

", + "ExplainabilitySummary$ExplainabilityConfig": "

The configuration settings that define the granularity of time series and time points for the Explainability.

" + } + }, + "ExplainabilityExportSummary": { + "base": "

Provides a summary of the Explainability export properties used in the ListExplainabilityExports operation. To get a complete set of properties, call the DescribeExplainabilityExport operation, and provide the ExplainabilityExportArn.

", + "refs": { + "ExplainabilityExports$member": null + } + }, + "ExplainabilityExports": { + "base": null, + "refs": { + "ListExplainabilityExportsResponse$ExplainabilityExports": "

An array of objects that summarize the properties of each Explainability export.

" + } + }, + "ExplainabilityInfo": { + "base": null, + "refs": { + "DescribeAutoPredictorResponse$ExplainabilityInfo": null + } + }, + "ExplainabilitySummary": { + "base": "

Provides a summary of the Explainability properties used in the ListExplainabilities operation. To get a complete set of properties, call the DescribeExplainability operation, and provide the listed ExplainabilityArn.

", + "refs": { + "Explainabilities$member": null + } + }, "Featurization": { "base": "

Provides featurization (transformation) information for a dataset field. This object is part of the FeaturizationConfig object.

For example:

{

\"AttributeName\": \"demand\",

FeaturizationPipeline [ {

\"FeaturizationMethodName\": \"filling\",

\"FeaturizationMethodParameters\": {\"aggregation\": \"avg\", \"backfill\": \"nan\"}

} ]

}

", "refs": { @@ -555,6 +748,8 @@ "base": null, "refs": { "ListDatasetImportJobsRequest$Filters": "

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the datasets that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

For example, to list all dataset import jobs whose status is ACTIVE, you specify the following filter:

\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" } ]

", + "ListExplainabilitiesRequest$Filters": "

An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.

Filter properties

", + "ListExplainabilityExportsRequest$Filters": "

An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude resources that match the statement from the list. The match statement consists of a key and a value.

Filter properties

", "ListForecastExportJobsRequest$Filters": "

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the forecast export jobs that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

For example, to list all jobs that export a forecast named electricityforecast, specify the following filter:

\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"ForecastArn\", \"Value\": \"arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityforecast\" } ]

", "ListForecastsRequest$Filters": "

An array of filters. For each filter, you provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the forecasts that match the statement from the list, respectively. The match statement consists of a key and a value.

Filter properties

For example, to list all forecasts whose status is not ACTIVE, you would specify:

\"Filters\": [ { \"Condition\": \"IS_NOT\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" } ]

", "ListPredictorBacktestExportJobsRequest$Filters": "

An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, which specifies whether to include or exclude the predictor backtest export jobs that match the statement from the list. The match statement consists of a key and a value.

Filter properties

", @@ -564,6 +759,7 @@ "ForecastDimensions": { "base": null, "refs": { + "CreateAutoPredictorRequest$ForecastDimensions": "

An array of dimension (field) names that specify how to group the generated forecast.

For example, if you are generating forecasts for item sales across all your stores, and your dataset contains a store_id field, you would specify store_id as a dimension to group sales forecasts for each store.

", "FeaturizationConfig$ForecastDimensions": "

An array of dimension (field) names that specify how to group the generated forecast.

For example, suppose that you are generating a forecast for item sales across all of your stores, and your dataset contains a store_id field. If you want the sales forecast for each item by store, you would specify store_id as the dimension.

All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't need to be specified in the CreatePredictor request. All forecast dimensions specified in the RELATED_TIME_SERIES dataset must be specified in the CreatePredictor request.

" } }, @@ -595,8 +791,10 @@ "ForecastTypes": { "base": null, "refs": { + "CreateAutoPredictorRequest$ForecastTypes": "

The forecast types used to train a predictor. You can specify up to five forecast types. Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or higher. You can also specify the mean forecast with mean.

", "CreateForecastRequest$ForecastTypes": "

The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial). The default value is [\"0.1\", \"0.5\", \"0.9\"].

", "CreatePredictorRequest$ForecastTypes": "

Specifies the forecast types used to train a predictor. You can specify up to five forecast types. Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or higher. You can also specify the mean forecast with mean.

The default value is [\"0.10\", \"0.50\", \"0.9\"].

", + "DescribeAutoPredictorResponse$ForecastTypes": "

The forecast types used during predictor training. Default value is [\"0.1\",\"0.5\",\"0.9\"].

", "DescribeForecastResponse$ForecastTypes": "

The quantiles at which probabilistic forecasts were generated.

", "DescribePredictorResponse$ForecastTypes": "

The forecast types used during predictor training. Default value is [\"0.1\",\"0.5\",\"0.9\"]

" } @@ -610,7 +808,9 @@ "Frequency": { "base": null, "refs": { + "CreateAutoPredictorRequest$ForecastFrequency": "

The frequency of predictions in a forecast.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"Y\" indicates every year and \"5min\" indicates every five minutes.

The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.

When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.

", "CreateDatasetRequest$DataFrequency": "

The frequency of data collection. This parameter is required for RELATED_TIME_SERIES datasets.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"D\" indicates every day and \"15min\" indicates every 15 minutes.

", + "DescribeAutoPredictorResponse$ForecastFrequency": "

The frequency of predictions in a forecast.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"Y\" indicates every year and \"5min\" indicates every five minutes.

", "DescribeDatasetResponse$DataFrequency": "

The frequency of data collection.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"M\" indicates every month and \"30min\" indicates every 30 minutes.

", "FeaturizationConfig$ForecastFrequency": "

The frequency of predictions in a forecast.

Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, \"Y\" indicates every year and \"5min\" indicates every five minutes.

The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset frequency.

When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the RELATED_TIME_SERIES dataset frequency.

" } @@ -649,7 +849,9 @@ "Integer": { "base": null, "refs": { + "CreateAutoPredictorRequest$ForecastHorizon": "

The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.

", "CreatePredictorRequest$ForecastHorizon": "

Specifies the number of time-steps that the model is trained to predict. The forecast horizon is also called the prediction length.

For example, if you configure a dataset for daily data collection (using the DataFrequency parameter of the CreateDataset operation) and set the forecast horizon to 10, the model returns predictions for 10 days.

The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the TARGET_TIME_SERIES dataset length.

", + "DescribeAutoPredictorResponse$ForecastHorizon": "

The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.

", "DescribePredictorResponse$ForecastHorizon": "

The number of time-steps of the forecast. The forecast horizon is also called the prediction length.

", "EvaluationParameters$NumberOfBacktestWindows": "

The number of times to split the input data. The default is 1. Valid values are 1 through 5.

", "EvaluationParameters$BackTestWindowOffset": "

The point from the end of the dataset where you want to split the data for model training and testing (evaluation). Specify the value as the number of data points. The default is the value of the forecast horizon. BackTestWindowOffset can be used to mimic a past virtual forecast start date. This value must be greater than or equal to the forecast horizon and less than half of the TARGET_TIME_SERIES dataset length.

ForecastHorizon <= BackTestWindowOffset < 1/2 * TARGET_TIME_SERIES dataset length

", @@ -726,6 +928,26 @@ "refs": { } }, + "ListExplainabilitiesRequest": { + "base": null, + "refs": { + } + }, + "ListExplainabilitiesResponse": { + "base": null, + "refs": { + } + }, + "ListExplainabilityExportsRequest": { + "base": null, + "refs": { + } + }, + "ListExplainabilityExportsResponse": { + "base": null, + "refs": { + } + }, "ListForecastExportJobsRequest": { "base": null, "refs": { @@ -776,10 +998,21 @@ "refs": { } }, + "LocalDateTime": { + "base": null, + "refs": { + "CreateExplainabilityRequest$StartDateTime": "

If TimePointGranularity is set to SPECIFIC, define the first point for the Explainability.

", + "CreateExplainabilityRequest$EndDateTime": "

If TimePointGranularity is set to SPECIFIC, define the last time point for the Explainability.

", + "DescribeExplainabilityResponse$StartDateTime": "

If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability.

", + "DescribeExplainabilityResponse$EndDateTime": "

If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability.

" + } + }, "Long": { "base": null, "refs": { + "DescribeAutoPredictorResponse$EstimatedTimeRemainingInMinutes": "

The estimated time remaining in minutes for the predictor training job to complete.

", "DescribeDatasetImportJobResponse$EstimatedTimeRemainingInMinutes": "

The estimated time remaining in minutes for the dataset import job to complete.

", + "DescribeExplainabilityResponse$EstimatedTimeRemainingInMinutes": "

The estimated time remaining in minutes for the CreateExplainability job to complete.

", "DescribeForecastResponse$EstimatedTimeRemainingInMinutes": "

The estimated time remaining in minutes for the forecast job to complete.

", "DescribePredictorResponse$EstimatedTimeRemainingInMinutes": "

The estimated time remaining in minutes for the predictor training job to complete.

", "Statistics$CountLong": "

The number of values in the field. CountLong is used instead of Count if the value is greater than 2,147,483,647.

", @@ -794,6 +1027,8 @@ "ListDatasetGroupsRequest$MaxResults": "

The number of items to return in the response.

", "ListDatasetImportJobsRequest$MaxResults": "

The number of items to return in the response.

", "ListDatasetsRequest$MaxResults": "

The number of items to return in the response.

", + "ListExplainabilitiesRequest$MaxResults": "

The number of items returned in the response.

", + "ListExplainabilityExportsRequest$MaxResults": "

The number of items to return in the response.

", "ListForecastExportJobsRequest$MaxResults": "

The number of items to return in the response.

", "ListForecastsRequest$MaxResults": "

The number of items to return in the response.

", "ListPredictorBacktestExportJobsRequest$MaxResults": "

The number of items to return in the response.

", @@ -803,10 +1038,14 @@ "Message": { "base": null, "refs": { + "DescribeAutoPredictorResponse$Message": "

In the event of an error, a message detailing the cause of the error.

", "DescribeDatasetImportJobResponse$Message": "

If an error occurred, an informational message about the error.

", + "DescribeExplainabilityExportResponse$Message": "

Information about any errors that occurred during the export.

", + "DescribeExplainabilityResponse$Message": "

If an error occurred, a message about the error.

", "DescribeForecastExportJobResponse$Message": "

If an error occurred, an informational message about the error.

", "DescribePredictorBacktestExportJobResponse$Message": "

Information about any errors that may have occurred during the backtest export.

", - "DescribePredictorResponse$Message": "

If an error occurred, an informational message about the error.

" + "DescribePredictorResponse$Message": "

If an error occurred, an informational message about the error.

", + "ExplainabilitySummary$Message": "

Information about any errors that may have occurred during the Explainability creation process.

" } }, "Metrics": { @@ -818,11 +1057,17 @@ "Name": { "base": null, "refs": { + "AdditionalDataset$Name": "

The name of the additional dataset. Valid names: \"holiday\" and \"weather\".

", + "AttributeConfig$AttributeName": "

The name of the attribute as specified in the schema. Amazon Forecast supports the target field of the target time series and the related time series datasets. For example, for the RETAIL domain, the target is demand.

", "CategoricalParameterRange$Name": "

The name of the categorical hyperparameter to tune.

", + "Configuration$key": null, "ContinuousParameterRange$Name": "

The name of the hyperparameter to tune.

", + "CreateAutoPredictorRequest$PredictorName": "

A unique name for the predictor

", "CreateDatasetGroupRequest$DatasetGroupName": "

A name for the dataset group.

", "CreateDatasetImportJobRequest$DatasetImportJobName": "

The name for the dataset import job. We recommend including the current timestamp in the name, for example, 20190721DatasetImport. This can help you avoid getting a ResourceAlreadyExistsException exception.

", "CreateDatasetRequest$DatasetName": "

A name for the dataset.

", + "CreateExplainabilityExportRequest$ExplainabilityExportName": "

A unique name for the Explainability export.

", + "CreateExplainabilityRequest$ExplainabilityName": "

A unique name for the Explainability.

", "CreateForecastExportJobRequest$ForecastExportJobName": "

The name for the forecast export job.

", "CreateForecastRequest$ForecastName": "

A name for the forecast.

", "CreatePredictorBacktestExportJobRequest$PredictorBacktestExportJobName": "

The name for the backtest export job.

", @@ -830,14 +1075,19 @@ "DatasetGroupSummary$DatasetGroupName": "

The name of the dataset group.

", "DatasetImportJobSummary$DatasetImportJobName": "

The name of the dataset import job.

", "DatasetSummary$DatasetName": "

The name of the dataset.

", + "DescribeAutoPredictorResponse$PredictorName": "

The name of the predictor.

", "DescribeDatasetGroupResponse$DatasetGroupName": "

The name of the dataset group.

", "DescribeDatasetImportJobResponse$DatasetImportJobName": "

The name of the dataset import job.

", "DescribeDatasetResponse$DatasetName": "

The name of the dataset.

", + "DescribeExplainabilityExportResponse$ExplainabilityExportName": "

The name of the Explainability export.

", + "DescribeExplainabilityResponse$ExplainabilityName": "

The name of the Explainability.

", "DescribeForecastExportJobResponse$ForecastExportJobName": "

The name of the forecast export job.

", "DescribeForecastResponse$ForecastName": "

The name of the forecast.

", "DescribePredictorBacktestExportJobResponse$PredictorBacktestExportJobName": "

The name of the predictor backtest export job.

", "DescribePredictorResponse$PredictorArn": "

The ARN of the predictor.

", "DescribePredictorResponse$PredictorName": "

The name of the predictor.

", + "ExplainabilityExportSummary$ExplainabilityExportName": "

The name of the Explainability export

", + "ExplainabilitySummary$ExplainabilityName": "

The name of the Explainability.

", "Featurization$AttributeName": "

The name of the schema attribute that specifies the data field to be featurized. Amazon Forecast supports the target field of the TARGET_TIME_SERIES and the RELATED_TIME_SERIES datasets. For example, for the RETAIL domain, the target is demand, and for the CUSTOM domain, the target is target_value. For more information, see howitworks-missing-values.

", "ForecastDimensions$member": null, "ForecastExportJobSummary$ForecastExportJobName": "

The name of the forecast export job.

", @@ -846,7 +1096,8 @@ "PredictorBacktestExportJobSummary$PredictorBacktestExportJobName": "

The name of the predictor backtest export job.

", "PredictorSummary$PredictorName": "

The name of the predictor.

", "SchemaAttribute$AttributeName": "

The name of the dataset field.

", - "SupplementaryFeature$Name": "

The name of the feature. Valid values: \"holiday\" and \"weather\".

" + "SupplementaryFeature$Name": "

The name of the feature. Valid values: \"holiday\" and \"weather\".

", + "Transformations$key": null } }, "NextToken": { @@ -858,6 +1109,10 @@ "ListDatasetImportJobsResponse$NextToken": "

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

", "ListDatasetsRequest$NextToken": "

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

", "ListDatasetsResponse$NextToken": "

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

", + "ListExplainabilitiesRequest$NextToken": "

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

", + "ListExplainabilitiesResponse$NextToken": "

Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.

", + "ListExplainabilityExportsRequest$NextToken": "

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

", + "ListExplainabilityExportsResponse$NextToken": "

Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.

", "ListForecastExportJobsRequest$NextToken": "

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

", "ListForecastExportJobsResponse$NextToken": "

If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of results, use the token in the next request.

", "ListForecastsRequest$NextToken": "

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

", @@ -871,7 +1126,9 @@ "OptimizationMetric": { "base": null, "refs": { + "CreateAutoPredictorRequest$OptimizationMetric": "

The accuracy metric used to optimize the predictor.

", "CreatePredictorRequest$OptimizationMetric": "

The accuracy metric used to optimize the predictor.

", + "DescribeAutoPredictorResponse$OptimizationMetric": "

The accuracy metric used to optimize the predictor.

", "DescribePredictorResponse$OptimizationMetric": "

The accuracy metric used to optimize the predictor.

", "GetAccuracyMetricsResponse$OptimizationMetric": "

The accuracy metric used to optimize the predictor.

" } @@ -944,6 +1201,13 @@ "ListPredictorsResponse$Predictors": "

An array of objects that summarize each predictor's properties.

" } }, + "ReferencePredictorSummary": { + "base": "

Provides a summary of the reference predictor used when retraining or upgrading a predictor.

", + "refs": { + "DescribeAutoPredictorResponse$ReferencePredictorSummary": "

The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.

", + "PredictorSummary$ReferencePredictorSummary": "

A summary of the reference predictor used if the predictor was retrained or upgraded.

" + } + }, "ResourceAlreadyExistsException": { "base": "

There is already a resource with this name. Try again with a different name.

", "refs": { @@ -983,7 +1247,9 @@ "base": "

Defines the fields of a dataset. You specify this object in the CreateDataset request.

", "refs": { "CreateDatasetRequest$Schema": "

The schema for the dataset. The schema attributes and their order must match the fields in your data. The dataset Domain and DatasetType that you choose determine the minimum required fields in your training data. For information about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types.

", - "DescribeDatasetResponse$Schema": "

An array of SchemaAttribute objects that specify the dataset fields. Each SchemaAttribute specifies the name and data type of a field.

" + "CreateExplainabilityRequest$Schema": null, + "DescribeDatasetResponse$Schema": "

An array of SchemaAttribute objects that specify the dataset fields. Each SchemaAttribute specifies the name and data type of a field.

", + "DescribeExplainabilityResponse$Schema": null } }, "SchemaAttribute": { @@ -998,6 +1264,12 @@ "Schema$Attributes": "

An array of attributes specifying the name and type of each field in a dataset.

" } }, + "State": { + "base": null, + "refs": { + "ReferencePredictorSummary$State": "

Whether the reference predictor is Active or Deleted.

" + } + }, "Statistics": { "base": "

Provides statistics for each data field imported into to an Amazon Forecast dataset with the CreateDatasetImportJob operation.

", "refs": { @@ -1008,12 +1280,18 @@ "base": null, "refs": { "DatasetImportJobSummary$Status": "

The status of the dataset import job. States include:

", + "DescribeAutoPredictorResponse$Status": "

The status of the predictor. States include:

", "DescribeDatasetGroupResponse$Status": "

The status of the dataset group. States include:

The UPDATE states apply when you call the UpdateDatasetGroup operation.

The Status of the dataset group must be ACTIVE before you can use the dataset group to create a predictor.

", "DescribeDatasetImportJobResponse$Status": "

The status of the dataset import job. States include:

", "DescribeDatasetResponse$Status": "

The status of the dataset. States include:

The UPDATE states apply while data is imported to the dataset from a call to the CreateDatasetImportJob operation and reflect the status of the dataset import job. For example, when the import job status is CREATE_IN_PROGRESS, the status of the dataset is UPDATE_IN_PROGRESS.

The Status of the dataset must be ACTIVE before you can import training data.

", + "DescribeExplainabilityExportResponse$Status": "

The status of the Explainability export. States include:

", + "DescribeExplainabilityResponse$Status": "

The status of the Explainability resource. States include:

", "DescribeForecastExportJobResponse$Status": "

The status of the forecast export job. States include:

The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.

", "DescribePredictorBacktestExportJobResponse$Status": "

The status of the predictor backtest export job. States include:

", "DescribePredictorResponse$Status": "

The status of the predictor. States include:

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

", + "ExplainabilityExportSummary$Status": "

The status of the Explainability export. States include:

", + "ExplainabilityInfo$Status": null, + "ExplainabilitySummary$Status": "

The status of the Explainability. States include:

", "ForecastExportJobSummary$Status": "

The status of the forecast export job. States include:

The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.

", "ForecastSummary$Status": "

The status of the forecast. States include:

The Status of the forecast must be ACTIVE before you can query or export the forecast.

", "PredictorBacktestExportJobSummary$Status": "

The status of the predictor backtest export job. States include:

", @@ -1088,9 +1366,12 @@ "Tags": { "base": null, "refs": { + "CreateAutoPredictorRequest$Tags": "

Optional metadata to help you categorize and organize your predictors. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

The following restrictions apply to tags:

", "CreateDatasetGroupRequest$Tags": "

The optional metadata that you apply to the dataset group to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

", "CreateDatasetImportJobRequest$Tags": "

The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

", "CreateDatasetRequest$Tags": "

The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

", + "CreateExplainabilityExportRequest$Tags": "

Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

The following restrictions apply to tags:

", + "CreateExplainabilityRequest$Tags": "

Optional metadata to help you categorize and organize your resources. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

The following restrictions apply to tags:

", "CreateForecastExportJobRequest$Tags": "

The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

", "CreateForecastRequest$Tags": "

The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

", "CreatePredictorBacktestExportJobRequest$Tags": "

Optional metadata to help you categorize and organize your backtests. Each tag consists of a key and an optional value, both of which you define. Tag keys and values are case sensitive.

The following restrictions apply to tags:

", @@ -1117,6 +1398,18 @@ "EvaluationResult$TestWindows": "

The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows from the EvaluationParameters object determines the number of windows in the array.

" } }, + "TimePointGranularity": { + "base": null, + "refs": { + "ExplainabilityConfig$TimePointGranularity": "

To create an Explainability for all time points in your forecast horizon, use ALL. To create an Explainability for specific time points in your forecast horizon, use SPECIFIC.

Specify time points with the StartDateTime and EndDateTime parameters within the CreateExplainability operation.

" + } + }, + "TimeSeriesGranularity": { + "base": null, + "refs": { + "ExplainabilityConfig$TimeSeriesGranularity": "

To create an Explainability for all time series in your datasets, use ALL. To create an Explainability for specific time series in your datasets, use SPECIFIC.

Specify time series by uploading a CSV file to an Amazon S3 bucket and set the location within the DataDestination data type.

" + } + }, "TimeZone": { "base": null, "refs": { @@ -1133,12 +1426,18 @@ "DatasetImportJobSummary$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", "DatasetSummary$CreationTime": "

When the dataset was created.

", "DatasetSummary$LastModificationTime": "

When you create a dataset, LastModificationTime is the same as CreationTime. While data is being imported to the dataset, LastModificationTime is the current time of the ListDatasets call. After a CreateDatasetImportJob operation has finished, LastModificationTime is when the import job completed or failed.

", + "DescribeAutoPredictorResponse$CreationTime": "

The timestamp of the CreateAutoPredictor request.

", + "DescribeAutoPredictorResponse$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", "DescribeDatasetGroupResponse$CreationTime": "

When the dataset group was created.

", "DescribeDatasetGroupResponse$LastModificationTime": "

When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated, LastModificationTime is the current time of the DescribeDatasetGroup call.

", "DescribeDatasetImportJobResponse$CreationTime": "

When the dataset import job was created.

", "DescribeDatasetImportJobResponse$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", "DescribeDatasetResponse$CreationTime": "

When the dataset was created.

", "DescribeDatasetResponse$LastModificationTime": "

When you create a dataset, LastModificationTime is the same as CreationTime. While data is being imported to the dataset, LastModificationTime is the current time of the DescribeDataset call. After a CreateDatasetImportJob operation has finished, LastModificationTime is when the import job completed or failed.

", + "DescribeExplainabilityExportResponse$CreationTime": "

When the Explainability export was created.

", + "DescribeExplainabilityExportResponse$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", + "DescribeExplainabilityResponse$CreationTime": "

When the Explainability resource was created.

", + "DescribeExplainabilityResponse$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", "DescribeForecastExportJobResponse$CreationTime": "

When the forecast export job was created.

", "DescribeForecastExportJobResponse$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", "DescribeForecastResponse$CreationTime": "

When the forecast creation task was created.

", @@ -1147,6 +1446,10 @@ "DescribePredictorBacktestExportJobResponse$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", "DescribePredictorResponse$CreationTime": "

When the model training task was created.

", "DescribePredictorResponse$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", + "ExplainabilityExportSummary$CreationTime": "

When the Explainability was created.

", + "ExplainabilityExportSummary$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", + "ExplainabilitySummary$CreationTime": "

When the Explainability was created.

", + "ExplainabilitySummary$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", "ForecastExportJobSummary$CreationTime": "

When the forecast export job was created.

", "ForecastExportJobSummary$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", "ForecastSummary$CreationTime": "

When the forecast creation task was created.

", @@ -1175,6 +1478,12 @@ "DescribePredictorResponse$TrainingParameters": "

The default training parameters or overrides selected during model training. When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.

" } }, + "Transformations": { + "base": null, + "refs": { + "AttributeConfig$Transformations": "

The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. Related Time Series attributes do not accept aggregation parameters.

The following list shows the parameters and their valid values for the \"filling\" featurization method for a Target Time Series dataset. Default values are bolded.

The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):

To set a filling method to a specific value, set the fill parameter to value and define the value in a corresponding _value parameter. For example, to set backfilling to a value of 2, include the following: \"backfill\": \"value\" and \"backfill_value\":\"2\".

" + } + }, "UntagResourceRequest": { "base": null, "refs": { @@ -1206,13 +1515,15 @@ "base": null, "refs": { "SupplementaryFeature$Value": "

Weather Index

To enable the Weather Index, set the value to \"true\"

Holidays

To enable Holidays, specify a country with one of the following two-letter country codes:

", + "Transformations$value": null, "Values$member": null } }, "Values": { "base": null, "refs": { - "CategoricalParameterRange$Values": "

A list of the tunable categories for the hyperparameter.

" + "CategoricalParameterRange$Values": "

A list of the tunable categories for the hyperparameter.

", + "Configuration$value": null } }, "WeightedQuantileLoss": { diff --git a/models/apis/ivs/2020-07-14/api-2.json b/models/apis/ivs/2020-07-14/api-2.json index 3ea2b38ccb..41a551cdc4 100644 --- a/models/apis/ivs/2020-07-14/api-2.json +++ b/models/apis/ivs/2020-07-14/api-2.json @@ -225,6 +225,21 @@ {"shape":"ValidationException"} ] }, + "GetStreamSession":{ + "name":"GetStreamSession", + "http":{ + "method":"POST", + "requestUri":"/GetStreamSession", + "responseCode":200 + }, + "input":{"shape":"GetStreamSessionRequest"}, + "output":{"shape":"GetStreamSessionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ] + }, "ImportPlaybackKeyPair":{ "name":"ImportPlaybackKeyPair", "http":{ @@ -301,6 +316,21 @@ {"shape":"ValidationException"} ] }, + "ListStreamSessions":{ + "name":"ListStreamSessions", + "http":{ + "method":"POST", + "requestUri":"/ListStreamSessions", + "responseCode":200 + }, + "input":{"shape":"ListStreamSessionsRequest"}, + "output":{"shape":"ListStreamSessionsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"} + ] + }, "ListStreams":{ "name":"ListStreams", "http":{ @@ -423,6 +453,15 @@ }, "exception":true }, + "AudioConfiguration":{ + "type":"structure", + "members":{ + "channels":{"shape":"Integer"}, + "codec":{"shape":"String"}, + "sampleRate":{"shape":"Integer"}, + "targetBitrate":{"shape":"Integer"} + } + }, "BatchError":{ "type":"structure", "members":{ @@ -708,6 +747,20 @@ "stream":{"shape":"Stream"} } }, + "GetStreamSessionRequest":{ + "type":"structure", + "required":["channelArn"], + "members":{ + "channelArn":{"shape":"ChannelArn"}, + "streamId":{"shape":"StreamId"} + } + }, + "GetStreamSessionResponse":{ + "type":"structure", + "members":{ + "streamSession":{"shape":"StreamSession"} + } + }, "ImportPlaybackKeyPairRequest":{ "type":"structure", "required":["publicKeyMaterial"], @@ -723,7 +776,15 @@ "keyPair":{"shape":"PlaybackKeyPair"} } }, + "IngestConfiguration":{ + "type":"structure", + "members":{ + "audio":{"shape":"AudioConfiguration"}, + "video":{"shape":"VideoConfiguration"} + } + }, "IngestEndpoint":{"type":"string"}, + "Integer":{"type":"long"}, "InternalServerException":{ "type":"structure", "members":{ @@ -798,9 +859,27 @@ "streamKeys":{"shape":"StreamKeyList"} } }, + "ListStreamSessionsRequest":{ + "type":"structure", + "required":["channelArn"], + "members":{ + "channelArn":{"shape":"ChannelArn"}, + "maxResults":{"shape":"MaxStreamResults"}, + "nextToken":{"shape":"PaginationToken"} + } + }, + "ListStreamSessionsResponse":{ + "type":"structure", + "required":["streamSessions"], + "members":{ + "nextToken":{"shape":"PaginationToken"}, + "streamSessions":{"shape":"StreamSessionList"} + } + }, "ListStreamsRequest":{ "type":"structure", "members":{ + "filterBy":{"shape":"StreamFilters"}, "maxResults":{"shape":"MaxStreamResults"}, "nextToken":{"shape":"PaginationToken"} } @@ -1034,9 +1113,30 @@ "playbackUrl":{"shape":"PlaybackURL"}, "startTime":{"shape":"StreamStartTime"}, "state":{"shape":"StreamState"}, + "streamId":{"shape":"StreamId"}, "viewerCount":{"shape":"StreamViewerCount"} } }, + "StreamEvent":{ + "type":"structure", + "members":{ + "eventTime":{"shape":"Time"}, + "name":{"shape":"String"}, + "type":{"shape":"String"} + } + }, + "StreamEvents":{ + "type":"list", + "member":{"shape":"StreamEvent"}, + "max":500, + "min":0 + }, + "StreamFilters":{ + "type":"structure", + "members":{ + "health":{"shape":"StreamHealth"} + } + }, "StreamHealth":{ "type":"string", "enum":[ @@ -1045,6 +1145,12 @@ "UNKNOWN" ] }, + "StreamId":{ + "type":"string", + "max":26, + "min":26, + "pattern":"^st-[a-zA-Z0-9]+$" + }, "StreamKey":{ "type":"structure", "members":{ @@ -1095,6 +1201,31 @@ "min":1, "sensitive":true }, + "StreamSession":{ + "type":"structure", + "members":{ + "channel":{"shape":"Channel"}, + "endTime":{"shape":"Time"}, + "ingestConfiguration":{"shape":"IngestConfiguration"}, + "recordingConfiguration":{"shape":"RecordingConfiguration"}, + "startTime":{"shape":"Time"}, + "streamId":{"shape":"StreamId"}, + "truncatedEvents":{"shape":"StreamEvents"} + } + }, + "StreamSessionList":{ + "type":"list", + "member":{"shape":"StreamSessionSummary"} + }, + "StreamSessionSummary":{ + "type":"structure", + "members":{ + "endTime":{"shape":"Time"}, + "hasErrorEvent":{"shape":"Boolean"}, + "startTime":{"shape":"Time"}, + "streamId":{"shape":"StreamId"} + } + }, "StreamStartTime":{ "type":"timestamp", "timestampFormat":"iso8601" @@ -1113,6 +1244,7 @@ "health":{"shape":"StreamHealth"}, "startTime":{"shape":"StreamStartTime"}, "state":{"shape":"StreamState"}, + "streamId":{"shape":"StreamId"}, "viewerCount":{"shape":"StreamViewerCount"} } }, @@ -1126,6 +1258,7 @@ "fault":true }, "StreamViewerCount":{"type":"long"}, + "String":{"type":"string"}, "TagKey":{ "type":"string", "max":128, @@ -1180,6 +1313,10 @@ }, "exception":true }, + "Time":{ + "type":"timestamp", + "timestampFormat":"iso8601" + }, "UntagResourceRequest":{ "type":"structure", "required":[ @@ -1233,6 +1370,19 @@ }, "exception":true }, + "VideoConfiguration":{ + "type":"structure", + "members":{ + "avcLevel":{"shape":"String"}, + "avcProfile":{"shape":"String"}, + "codec":{"shape":"String"}, + "encoder":{"shape":"String"}, + "targetBitrate":{"shape":"Integer"}, + "targetFramerate":{"shape":"Integer"}, + "videoHeight":{"shape":"Integer"}, + "videoWidth":{"shape":"Integer"} + } + }, "errorCode":{"type":"string"}, "errorMessage":{"type":"string"} } diff --git a/models/apis/ivs/2020-07-14/docs-2.json b/models/apis/ivs/2020-07-14/docs-2.json index 5032e4aec3..4e7697be47 100644 --- a/models/apis/ivs/2020-07-14/docs-2.json +++ b/models/apis/ivs/2020-07-14/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "

Introduction

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both requests and responses, including errors.

The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the Amazon Web Services General Reference.

All API request parameters and URLs are case sensitive.

For a summary of notable documentation changes in each release, see Document History.

 <p> <b>Allowed Header Values</b> </p> <ul> <li> <p> <code> <b>Accept:</b> </code> application/json</p> </li> <li> <p> <code> <b>Accept-Encoding:</b> </code> gzip, deflate</p> </li> <li> <p> <code> <b>Content-Type:</b> </code>application/json</p> </li> </ul> <p> <b>Resources</b> </p> <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html"> Getting Started with Amazon IVS</a>):</p> <ul> <li> <p>Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream. See the Channel endpoints for more information. </p> </li> <li> <p>Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. See the StreamKey endpoints for more information. <i> <b>Treat the stream key like a secret, since it allows anyone to stream to the channel.</b> </i> </p> </li> <li> <p>Playback key pair — Video playback may be restricted using playback-authorization tokens, which use public-key encryption. A playback key pair is the public-private pair of keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair endpoints for more information.</p> </li> <li> <p>Recording configuration — Stores configuration related to recording a live stream and where to store the recorded content. Multiple channels can reference the same recording configuration. See the Recording Configuration endpoints for more information.</p> </li> </ul> <p> <b>Tagging</b> </p> <p>A <i>tag</i> is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a <i>key</i> and a <i>value</i>, both set by you. For example, you might set a tag as <code>topic:nature</code> to label a particular video category. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions that apply to tags.</p> <p>Tags can help you identify and organize your Amazon Web Services resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html"> Access Tags</a>). </p> <p>The Amazon IVS API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a>. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.</p> <p>At most 50 tags can be applied to a resource. </p> <p> <b>Authentication versus Authorization</b> </p> <p>Note the differences between these concepts:</p> <ul> <li> <p> <i>Authentication</i> is about verifying identity. You need to be authenticated to sign Amazon IVS API requests.</p> </li> <li> <p> <i>Authorization</i> is about granting permissions. You need to be authorized to view <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Amazon IVS private channels</a>. (Private channels are channels that are enabled for "playback authorization.")</p> </li> </ul> <p> <b>Authentication</b> </p> <p>All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.</p> <p>You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from an IAM user account that has the <code>ivs:PutMetadata</code> permission.</p> <p>For more information:</p> <ul> <li> <p>Authentication and generating signatures — See <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating Requests (Amazon Web Services Signature Version 4)</a> in the <i>Amazon Web Services General Reference</i>.</p> </li> <li> <p>Managing Amazon IVS permissions — See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html">Identity and Access Management</a> on the Security page of the <i>Amazon IVS User Guide</i>.</p> </li> </ul> <p> <b>Channel Endpoints</b> </p> <ul> <li> <p> <a>CreateChannel</a> — Creates a new channel and an associated stream key to start streaming.</p> </li> <li> <p> <a>GetChannel</a> — Gets the channel configuration for the specified channel ARN (Amazon Resource Name).</p> </li> <li> <p> <a>BatchGetChannel</a> — Performs <a>GetChannel</a> on multiple ARNs simultaneously.</p> </li> <li> <p> <a>ListChannels</a> — Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 Conflict Exception).</p> </li> <li> <p> <a>UpdateChannel</a> — Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.</p> </li> <li> <p> <a>DeleteChannel</a> — Deletes the specified channel.</p> </li> </ul> <p> <b>StreamKey Endpoints</b> </p> <ul> <li> <p> <a>CreateStreamKey</a> — Creates a stream key, used to initiate a stream, for the specified channel ARN.</p> </li> <li> <p> <a>GetStreamKey</a> — Gets stream key information for the specified ARN.</p> </li> <li> <p> <a>BatchGetStreamKey</a> — Performs <a>GetStreamKey</a> on multiple ARNs simultaneously.</p> </li> <li> <p> <a>ListStreamKeys</a> — Gets summary information about stream keys for the specified channel.</p> </li> <li> <p> <a>DeleteStreamKey</a> — Deletes the stream key for the specified ARN, so it can no longer be used to stream.</p> </li> </ul> <p> <b>Stream Endpoints</b> </p> <ul> <li> <p> <a>GetStream</a> — Gets information about the active (live) stream on a specified channel.</p> </li> <li> <p> <a>ListStreams</a> — Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.</p> </li> <li> <p> <a>StopStream</a> — Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with <a>DeleteStreamKey</a> to prevent further streaming to a channel.</p> </li> <li> <p> <a>PutMetadata</a> — Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed.</p> </li> </ul> <p> <b>PlaybackKeyPair Endpoints</b> </p> <p>For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the <i>Amazon IVS User Guide</i>.</p> <ul> <li> <p> <a>ImportPlaybackKeyPair</a> — Imports the public portion of a new key pair and returns its <code>arn</code> and <code>fingerprint</code>. The <code>privateKey</code> can then be used to generate viewer authorization tokens, to grant viewers access to private channels (channels enabled for playback authorization).</p> </li> <li> <p> <a>GetPlaybackKeyPair</a> — Gets a specified playback authorization key pair and returns the <code>arn</code> and <code>fingerprint</code>. The <code>privateKey</code> held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels.</p> </li> <li> <p> <a>ListPlaybackKeyPairs</a> — Gets summary information about playback key pairs.</p> </li> <li> <p> <a>DeletePlaybackKeyPair</a> — Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s <code>privateKey</code>.</p> </li> </ul> <p> <b>RecordingConfiguration Endpoints</b> </p> <ul> <li> <p> <a>CreateRecordingConfiguration</a> — Creates a new recording configuration, used to enable recording to Amazon S3.</p> </li> <li> <p> <a>GetRecordingConfiguration</a> — Gets the recording-configuration metadata for the specified ARN.</p> </li> <li> <p> <a>ListRecordingConfigurations</a> — Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.</p> </li> <li> <p> <a>DeleteRecordingConfiguration</a> — Deletes the recording configuration for the specified ARN.</p> </li> </ul> <p> <b>Amazon Web Services Tags Endpoints</b> </p> <ul> <li> <p> <a>TagResource</a> — Adds or updates tags for the Amazon Web Services resource with the specified ARN.</p> </li> <li> <p> <a>UntagResource</a> — Removes tags from the resource with the specified ARN.</p> </li> <li> <p> <a>ListTagsForResource</a> — Gets information about Amazon Web Services tags for the specified ARN.</p> </li> </ul>
", + "service": "

Introduction

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an Amazon Web Services EventBridge event stream for responses. JSON is used for both requests and responses, including errors.

The API is an Amazon Web Services regional service. For a list of supported regions and Amazon IVS HTTPS service endpoints, see the Amazon IVS page in the Amazon Web Services General Reference.

All API request parameters and URLs are case sensitive.

For a summary of notable documentation changes in each release, see Document History.

Allowed Header Values

Resources

The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):

Tagging

A tag is a metadata label that you assign to an Amazon Web Services resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags.

Tags can help you identify and organize your Amazon Web Services resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording Configurations.

At most 50 tags can be applied to a resource.

Authentication versus Authorization

Note the differences between these concepts:

Authentication

All Amazon IVS API requests must be authenticated with a signature. The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for you. However, if your application calls the Amazon IVS API directly, it’s your responsibility to sign the requests.

You generate a signature using valid Amazon Web Services credentials that have permission to perform the requested action. For example, you must sign PutMetadata requests with a signature generated from an IAM user account that has the ivs:PutMetadata permission.

For more information:

Channel Endpoints

StreamKey Endpoints

Stream Endpoints

PlaybackKeyPair Endpoints

For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

RecordingConfiguration Endpoints

Amazon Web Services Tags Endpoints

", "operations": { "BatchGetChannel": "

Performs GetChannel on multiple ARNs simultaneously.

", "BatchGetStreamKey": "

Performs GetStreamKey on multiple ARNs simultaneously.

", @@ -16,11 +16,13 @@ "GetRecordingConfiguration": "

Gets the recording configuration for the specified ARN.

", "GetStream": "

Gets information about the active (live) stream on a specified channel.

", "GetStreamKey": "

Gets stream-key information for a specified ARN.

", + "GetStreamSession": "

Gets metadata on a specified stream.

", "ImportPlaybackKeyPair": "

Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

", "ListChannels": "

Gets summary information about all channels in your account, in the Amazon Web Services region where the API request is processed. This list can be filtered to match a specified name or recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If you try to use both filters, you will get an error (409 ConflictException).

", "ListPlaybackKeyPairs": "

Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.

", "ListRecordingConfigurations": "

Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.

", "ListStreamKeys": "

Gets summary information about stream keys for the specified channel.

", + "ListStreamSessions": "

Gets a summary of current and previous streams for a specified channel in your account, in the AWS region where the API request is processed.

", "ListStreams": "

Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.

", "ListTagsForResource": "

Gets information about Amazon Web Services tags for the specified ARN.

", "PutMetadata": "

Inserts metadata into the active stream of the specified channel. At most 5 requests per second per channel are allowed, each with a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching your data into a single PutMetadata call.) At most 155 requests per second per account are allowed. Also see Embedding Metadata within a Video Stream in the Amazon IVS User Guide.

", @@ -35,6 +37,12 @@ "refs": { } }, + "AudioConfiguration": { + "base": "

Object specifying a stream’s audio configuration.

", + "refs": { + "IngestConfiguration$audio": "

Encoder settings for audio.

" + } + }, "BatchError": { "base": "

Error related to a specific channel, specified by its ARN.

", "refs": { @@ -72,6 +80,7 @@ "base": null, "refs": { "CreateChannelRequest$authorized": "

Whether the channel is private (enabled for playback authorization). Default: false.

", + "StreamSessionSummary$hasErrorEvent": "

If true, this stream encountered a quota breach or failure.

", "UpdateChannelRequest$authorized": "

Whether the channel is private (enabled for playback authorization).

" } }, @@ -81,6 +90,7 @@ "Channels$member": null, "CreateChannelResponse$channel": "

", "GetChannelResponse$channel": "

", + "StreamSession$channel": "

The properties of the channel at the time of going live.

", "UpdateChannelResponse$channel": null } }, @@ -94,7 +104,9 @@ "DeleteChannelRequest$arn": "

ARN of the channel to be deleted.

", "GetChannelRequest$arn": "

ARN of the channel for which the configuration is to be retrieved.

", "GetStreamRequest$channelArn": "

Channel ARN for stream to be accessed.

", + "GetStreamSessionRequest$channelArn": "

ARN of the channel resource

", "ListStreamKeysRequest$channelArn": "

Channel ARN used to filter the list.

", + "ListStreamSessionsRequest$channelArn": "

Channel ARN used to filter the list.

", "PutMetadataRequest$channelArn": "

ARN of the channel into which metadata is inserted. This channel must have an active stream.

", "StopStreamRequest$channelArn": "

ARN of the channel for which the stream is to be stopped.

", "Stream$channelArn": "

Channel ARN for the stream.

", @@ -288,6 +300,16 @@ "refs": { } }, + "GetStreamSessionRequest": { + "base": null, + "refs": { + } + }, + "GetStreamSessionResponse": { + "base": null, + "refs": { + } + }, "ImportPlaybackKeyPairRequest": { "base": null, "refs": { @@ -298,12 +320,30 @@ "refs": { } }, + "IngestConfiguration": { + "base": "

Object specifying the ingest configuration set up by the broadcaster, usually in an encoder.

", + "refs": { + "StreamSession$ingestConfiguration": "

The properties of the incoming RTMP stream for the stream.

" + } + }, "IngestEndpoint": { "base": null, "refs": { "Channel$ingestEndpoint": "

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

" } }, + "Integer": { + "base": null, + "refs": { + "AudioConfiguration$channels": "

Number of audio channels.

", + "AudioConfiguration$sampleRate": "

Number of audio samples recorded per second.

", + "AudioConfiguration$targetBitrate": "

The expected ingest bitrate (bits per second). This is configured in the encoder.

", + "VideoConfiguration$targetBitrate": "

The expected ingest bitrate (bits per second). This is configured in the encoder.

", + "VideoConfiguration$targetFramerate": "

The expected ingest framerate. This is configured in the encoder.

", + "VideoConfiguration$videoHeight": "

Video-resolution height in pixels.

", + "VideoConfiguration$videoWidth": "

Video-resolution width in pixels.

" + } + }, "InternalServerException": { "base": "

", "refs": { @@ -356,6 +396,16 @@ "refs": { } }, + "ListStreamSessionsRequest": { + "base": null, + "refs": { + } + }, + "ListStreamSessionsResponse": { + "base": null, + "refs": { + } + }, "ListStreamsRequest": { "base": null, "refs": { @@ -403,6 +453,7 @@ "MaxStreamResults": { "base": null, "refs": { + "ListStreamSessionsRequest$maxResults": "

Maximum number of streams to return. Default: 50.

", "ListStreamsRequest$maxResults": "

Maximum number of streams to return. Default: 50.

" } }, @@ -417,6 +468,8 @@ "ListRecordingConfigurationsResponse$nextToken": "

If there are more recording configurations than maxResults, use nextToken in the request to get the next set.

", "ListStreamKeysRequest$nextToken": "

The first stream key to retrieve. This is used for pagination; see the nextToken response field.

", "ListStreamKeysResponse$nextToken": "

If there are more stream keys than maxResults, use nextToken in the request to get the next set.

", + "ListStreamSessionsRequest$nextToken": "

The first stream to retrieve. This is used for pagination; see the nextToken response field.

", + "ListStreamSessionsResponse$nextToken": "

If there are more streams than maxResults, use nextToken in the request to get the next set.

", "ListStreamsRequest$nextToken": "

The first stream to retrieve. This is used for pagination; see the nextToken response field.

", "ListStreamsResponse$nextToken": "

If there are more streams than maxResults, use nextToken in the request to get the next set.

" } @@ -490,7 +543,8 @@ "base": "

An object representing a configuration to record a channel stream.

", "refs": { "CreateRecordingConfigurationResponse$recordingConfiguration": "", - "GetRecordingConfigurationResponse$recordingConfiguration": "" + "GetRecordingConfigurationResponse$recordingConfiguration": "", + "StreamSession$recordingConfiguration": "

The properties of recording the live stream.

" } }, "RecordingConfigurationArn": { @@ -576,13 +630,42 @@ "GetStreamResponse$stream": "

" } }, + "StreamEvent": { + "base": "

Object specifying a stream’s events. For a list of events, see Using Amazon EventBridge with Amazon IVS.

", + "refs": { + "StreamEvents$member": null + } + }, + "StreamEvents": { + "base": null, + "refs": { + "StreamSession$truncatedEvents": "

List of Amazon IVS events that the stream encountered. The list is sorted by most recent events and contains up to 500 events. For Amazon IVS events, see Using Amazon EventBridge with Amazon IVS.

" + } + }, + "StreamFilters": { + "base": "

Object specifying the stream attribute on which to filter.

", + "refs": { + "ListStreamsRequest$filterBy": "

Filters the stream list to match the specified criterion.

" + } + }, "StreamHealth": { "base": null, "refs": { "Stream$health": "

The stream’s health.

", + "StreamFilters$health": "

The stream’s health.

", "StreamSummary$health": "

The stream’s health.

" } }, + "StreamId": { + "base": null, + "refs": { + "GetStreamSessionRequest$streamId": "

Unique identifier for a live or previously live stream in the specified channel. If no streamId is provided, this returns the most recent stream session for the channel, if it exists.

", + "Stream$streamId": "

Unique identifier for a live or previously live stream in the specified channel.

", + "StreamSession$streamId": "

Unique identifier for a live or previously live stream in the specified channel.

", + "StreamSessionSummary$streamId": "

Unique identifier for a live or previously live stream in the specified channel.

", + "StreamSummary$streamId": "

Unique identifier for a live or previously live stream in the specified channel.

" + } + }, "StreamKey": { "base": "

Object specifying a stream key.

", "refs": { @@ -644,6 +727,24 @@ "PutMetadataRequest$metadata": "

Metadata to insert into the stream. Maximum: 1 KB per request.

" } }, + "StreamSession": { + "base": "

Object that captures the Amazon IVS configuration that the customer provisioned, the ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events it encountered.

", + "refs": { + "GetStreamSessionResponse$streamSession": "

List of stream details.

" + } + }, + "StreamSessionList": { + "base": null, + "refs": { + "ListStreamSessionsResponse$streamSessions": "

" + } + }, + "StreamSessionSummary": { + "base": "

Summary information about a stream session.

", + "refs": { + "StreamSessionList$member": null + } + }, "StreamStartTime": { "base": null, "refs": { @@ -676,6 +777,18 @@ "StreamSummary$viewerCount": "

A count of concurrent views of the stream. Typically, a new view appears in viewerCount within 15 seconds of when video playback starts and a view is removed from viewerCount within 1 minute of when video playback ends. A value of -1 indicates that the request timed out; in this case, retry.

" } }, + "String": { + "base": null, + "refs": { + "AudioConfiguration$codec": "

Codec used for the audio encoding.

", + "StreamEvent$name": "

Name that identifies the stream event within a type.

", + "StreamEvent$type": "

Logical group for certain events.

", + "VideoConfiguration$avcLevel": "

Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.

", + "VideoConfiguration$avcProfile": "

Indicates to the decoder the requirements for decoding the stream. For definitions of the valid values, see the H.264 specification.

", + "VideoConfiguration$codec": "

Codec used for the video encoding.

", + "VideoConfiguration$encoder": "

Software or hardware used to encode the video.

" + } + }, "TagKey": { "base": null, "refs": { @@ -729,6 +842,16 @@ "refs": { } }, + "Time": { + "base": null, + "refs": { + "StreamEvent$eventTime": "

UTC ISO-8601 formatted timestamp of when the event occurred.

", + "StreamSession$endTime": "

UTC ISO-8601 formatted timestamp of when the channel went offline. For live streams, this is NULL.

", + "StreamSession$startTime": "

UTC ISO-8601 formatted timestamp of when the channel went live.

", + "StreamSessionSummary$endTime": "

UTC ISO-8601 formatted timestamp of when the channel went offline. For live streams, this is NULL.

", + "StreamSessionSummary$startTime": "

UTC ISO-8601 formatted timestamp of when the channel went live.

" + } + }, "UntagResourceRequest": { "base": null, "refs": { @@ -754,6 +877,12 @@ "refs": { } }, + "VideoConfiguration": { + "base": "

Object specifying a stream’s video configuration.

", + "refs": { + "IngestConfiguration$video": "

Encoder settings for video.

" + } + }, "errorCode": { "base": null, "refs": { diff --git a/models/apis/ivs/2020-07-14/paginators-1.json b/models/apis/ivs/2020-07-14/paginators-1.json index 9a14986bb8..e6daa88861 100644 --- a/models/apis/ivs/2020-07-14/paginators-1.json +++ b/models/apis/ivs/2020-07-14/paginators-1.json @@ -20,6 +20,11 @@ "output_token": "nextToken", "limit_key": "maxResults" }, + "ListStreamSessions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, "ListStreams": { "input_token": "nextToken", "output_token": "nextToken", diff --git a/models/apis/kafka/2018-11-14/api-2.json b/models/apis/kafka/2018-11-14/api-2.json index 9910b03055..92119efacb 100644 --- a/models/apis/kafka/2018-11-14/api-2.json +++ b/models/apis/kafka/2018-11-14/api-2.json @@ -911,6 +911,43 @@ } ] }, + "UpdateConnectivity":{ + "name":"UpdateConnectivity", + "http":{ + "method":"PUT", + "requestUri":"/v1/clusters/{clusterArn}/connectivity", + "responseCode":200 + }, + "input":{ + "shape":"UpdateConnectivityRequest" + }, + "output":{ + "shape":"UpdateConnectivityResponse" + }, + "errors":[ + { + "shape":"BadRequestException" + }, + { + "shape":"UnauthorizedException" + }, + { + "shape":"InternalServerErrorException" + }, + { + "shape":"ForbiddenException" + }, + { + "shape":"NotFoundException" + }, + { + "shape":"ServiceUnavailableException" + }, + { + "shape":"TooManyRequestsException" + } + ] + }, "UpdateMonitoring" : { "name" : "UpdateMonitoring", "http" : { @@ -1074,6 +1111,10 @@ "StorageInfo": { "shape": "StorageInfo", "locationName": "storageInfo" + }, + "ConnectivityInfo":{ + "shape":"ConnectivityInfo", + "locationName":"connectivityInfo" } }, "required": [ @@ -1445,6 +1486,15 @@ "httpStatusCode": 409 } }, + "ConnectivityInfo":{ + "type":"structure", + "members":{ + "PublicAccess":{ + "shape":"PublicAccess", + "locationName":"publicAccess" + } + } + }, "CreateClusterRequest": { "type": "structure", "members": { @@ -1919,6 +1969,18 @@ "shape": "__string", "locationName": "bootstrapBrokerString" }, + "BootstrapBrokerStringPublicSaslIam" : { + "shape" : "__string", + "locationName" : "bootstrapBrokerStringPublicSaslIam" + }, + "BootstrapBrokerStringPublicSaslScram" : { + "shape" : "__string", + "locationName" : "bootstrapBrokerStringPublicSaslScram" + }, + "BootstrapBrokerStringPublicTls" : { + "shape" : "__string", + "locationName" : "bootstrapBrokerStringPublicTls" + }, "BootstrapBrokerStringTls": { "shape": "__string", "locationName": "bootstrapBrokerStringTls" @@ -2299,6 +2361,10 @@ "EncryptionInfo" : { "shape" : "EncryptionInfo", "locationName" : "encryptionInfo" + }, + "ConnectivityInfo":{ + "shape":"ConnectivityInfo", + "locationName":"connectivityInfo" } } }, @@ -2749,6 +2815,42 @@ } } }, + "UpdateConnectivityRequest":{ + "type":"structure", + "members":{ + "ClusterArn":{ + "shape":"__string", + "location":"uri", + "locationName":"clusterArn" + }, + "ConnectivityInfo":{ + "shape":"ConnectivityInfo", + "locationName":"connectivityInfo" + }, + "CurrentVersion":{ + "shape":"__string", + "locationName":"currentVersion" + } + }, + "required":[ + "ClusterArn", + "ConnectivityInfo", + "CurrentVersion" + ] + }, + "UpdateConnectivityResponse":{ + "type":"structure", + "members":{ + "ClusterArn":{ + "shape":"__string", + "locationName":"clusterArn" + }, + "ClusterOperationArn":{ + "shape":"__string", + "locationName":"clusterOperationArn" + } + } + }, "UpdateMonitoringRequest" : { "type" : "structure", "members" : { @@ -2896,6 +2998,15 @@ } } }, + "PublicAccess":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"__string", + "locationName":"type" + } + } + }, "RebootBrokerRequest": { "type": "structure", "members": { diff --git a/models/apis/kafka/2018-11-14/docs-2.json b/models/apis/kafka/2018-11-14/docs-2.json index 4e745cd1c3..a88d4e8af9 100644 --- a/models/apis/kafka/2018-11-14/docs-2.json +++ b/models/apis/kafka/2018-11-14/docs-2.json @@ -18,7 +18,7 @@ "ListClusters" : "

Returns a list of all the MSK clusters in the current Region.

", "ListConfigurationRevisions" : "

Returns a list of all the revisions of an MSK configuration.

", "ListConfigurations" : "

Returns a list of all the MSK configurations in this Region.

", - "ListKafkaVersions" : "

Returns a list of Kafka versions.

", + "ListKafkaVersions" : "

Returns a list of Apache Kafka versions.

", "ListNodes" : "

Returns a list of the broker nodes in the cluster.

", "ListScramSecrets" : "

Returns a list of the Scram Secrets associated with an Amazon MSK cluster.

", "ListTagsForResource" : "

Returns a list of the tags associated with the specified resource.

", @@ -29,6 +29,7 @@ "UpdateBrokerType": "

Updates all the brokers in the cluster to the specified type.

", "UpdateBrokerStorage" : "

Updates the EBS storage associated with MSK brokers.

", "UpdateConfiguration" : "

Updates an existing MSK configuration. The configuration must be in the Active state.

", + "UpdateConnectivity" : "

Updates the connectivity configuration for the cluster.

", "UpdateClusterConfiguration" : "

Updates the cluster with the configuration that is specified in the request body.

", "UpdateClusterKafkaVersion" : "

Updates the Apache Kafka version for the cluster.

", "UpdateMonitoring" : "

Updates the monitoring settings for the cluster. You can use this operation to specify which Apache Kafka metrics you want Amazon MSK to send to Amazon CloudWatch. You can also specify settings for open monitoring with Prometheus.

", @@ -66,7 +67,7 @@ } }, "BrokerNodeGroupInfo" : { - "base" : "

Describes the setup to be used for Kafka broker nodes in the cluster.

", + "base" : "

Describes the setup to be used for Apache Kafka broker nodes in the cluster.

", "refs" : { "ClusterInfo$BrokerNodeGroupInfo" : "

Information about the brokers.

", "CreateClusterRequest$BrokerNodeGroupInfo" : "

Information about the brokers.

" @@ -81,8 +82,8 @@ "BrokerSoftwareInfo" : { "base" : "

Information about the current software installed on the cluster.

", "refs" : { - "BrokerNodeInfo$CurrentBrokerSoftwareInfo" : "

Information about the version of software currently deployed on the Kafka brokers in the cluster.

", - "ClusterInfo$CurrentBrokerSoftwareInfo" : "

Information about the version of software currently deployed on the Kafka brokers in the cluster.

" + "BrokerNodeInfo$CurrentBrokerSoftwareInfo" : "

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

", + "ClusterInfo$CurrentBrokerSoftwareInfo" : "

Information about the version of software currently deployed on the Apache Kafka brokers in the cluster.

" } }, "ClientAuthentication" : { @@ -133,7 +134,7 @@ } }, "ClusterState" : { - "base" : "

The state of a Kafka cluster.

", + "base" : "

The state of an Apache Kafka cluster.

", "refs" : { "ClusterInfo$State" : "

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

", "CreateClusterResponse$State" : "

The state of the cluster. The possible states are ACTIVE, CREATING, DELETING, FAILED, HEALING, MAINTENANCE, REBOOTING_BROKER, and UPDATING.

", @@ -141,7 +142,7 @@ } }, "CompatibleKafkaVersion" : { - "base" : "

Contains source Kafka versions and compatible target Kafka versions.

", + "base" : "

Contains source Apache Kafka versions and compatible target Apache Kafka versions.

", "refs" : { "__listOfCompatibleKafkaVersion$member" : null } @@ -182,6 +183,14 @@ "base" : "

Returns information about an error.

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

Information about the broker access configuration.

", + "refs" : { + "BrokerNodeGroupInfo$ConnectivityInfo" : "

Information about the broker access configuration.

", + "MutableClusterInfo$ConnectivityInfo" : "

Information about the broker access configuration.

", + "UpdateConnectivityRequest$ConnectivityInfo" : "

Information about the broker access configuration.

" + } + }, "CreateClusterRequest" : { "base" : "

Creates a cluster.

", "refs" : { } @@ -235,7 +244,7 @@ "refs" : { } }, "EBSStorageInfo" : { - "base" : "

Contains information about the EBS storage volumes attached to Kafka broker nodes.

", + "base" : "

Contains information about the EBS storage volumes attached to Apache Kafka broker nodes.

", "refs" : { "StorageInfo$EbsStorageInfo" : "

EBS volume information.

" } @@ -315,13 +324,13 @@ } }, "KafkaVersion" : { - "base" : "

Information about a Kafka version.

", + "base" : "

Information about a Apache Kafka version.

", "refs" : { "__listOfKafkaVersion$member" : null } }, "KafkaVersionStatus" : { - "base" : "

The status of a Kafka version.

", + "base" : "

The status of a Apache Kafka version.

", "refs" : { "KafkaVersion$Status" : "

The status of the Apache Kafka version.

" } @@ -428,6 +437,12 @@ "OpenMonitoringInfo$Prometheus" : "

Prometheus settings.

" } }, + "PublicAccess" : { + "base" : "

Broker public access control.

", + "refs" : { + "ConnectivityInfo$PublicAccess" : "

Public access control for brokers.

" + } + }, "RebootBrokerRequest" : { "base" : "

Request body for RebootBrokerNode action.

", "refs" : { } @@ -514,6 +529,14 @@ "base" : "

Response body for UpdateConfiguration.

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

Request body for UpdateConnectivity.

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

Response body for UpdateConnectivity.

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

Request body for UpdateClusterConfiguration.

", "refs" : { } @@ -588,7 +611,7 @@ "__integerMin1Max15" : { "base" : null, "refs" : { - "CreateClusterRequest$NumberOfBrokerNodes": "

The number of Kafka broker nodes in the Amazon MSK cluster.

", + "CreateClusterRequest$NumberOfBrokerNodes": "

The number of Apache Kafka broker nodes in the Amazon MSK cluster.

", "UpdateBrokerCountRequest$TargetNumberOfBrokerNodes" : "

The number of broker nodes that you want the cluster to have after this operation completes successfully.

" } }, @@ -644,7 +667,7 @@ "__listOfKafkaVersion" : { "base" : null, "refs" : { - "ListKafkaVersionsResponse$KafkaVersions" : "

An array of Kafka version objects.

" + "ListKafkaVersionsResponse$KafkaVersions" : "

An array of Apache Kafka version objects.

" } }, "__listOfNodeInfo" : { @@ -746,10 +769,13 @@ "ErrorInfo$ErrorString" : "

An optional field to provide more details about the error.

", "Firehose$DeliveryStream" : "

The Kinesis Data Firehose delivery stream that is the destination for broker logs.

", "GetBootstrapBrokersResponse$BootstrapBrokerString" : "

A string containing one or more hostname:port pairs.

", - "GetBootstrapBrokersResponse$BootstrapBrokerStringTls" : "

A string containing one or more DNS names (or IP) and TLS port pairs. The following is an example.

{\n \"BootstrapBrokerStringTls\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094\"\n}", - "GetBootstrapBrokersResponse$BootstrapBrokerStringSaslScram" : "

A string containing one or more DNS names (or IP) and SASL SCRAM port pairs. The following is an example.

{\n \"BootstrapBrokerStringSaslScram\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096\"\n}", + "GetBootstrapBrokersResponse$BootstrapBrokerStringTls" : "

A string containing one or more DNS names (or IP addresses) and TLS port pairs. The following is an example.

{\n \"BootstrapBrokerStringTls\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094\"\n}", + "GetBootstrapBrokersResponse$BootstrapBrokerStringSaslScram" : "

A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs. The following is an example.

{\n \"BootstrapBrokerStringSaslScram\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096\"\n}", "GetBootstrapBrokersResponse$BootstrapBrokerStringSaslIam" : "

A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs. The following is an example.

{\n \"BootstrapBrokerStringSaslIam\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098\"\n}", - "KafkaVersion$Version" : "

The Kafka version.

", + "GetBootstrapBrokersResponse$BootstrapBrokerStringPublicTls" : "

A string containing one or more DNS names (or IP addresses) and TLS port pairs. The following is an example.

{\n \"BootstrapBrokerStringTls\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194\"\n}", + "GetBootstrapBrokersResponse$BootstrapBrokerStringPublicSaslScram" : "

A string containing one or more DNS names (or IP addresses) and SASL SCRAM port pairs. The following is an example.

{\n \"BootstrapBrokerStringSaslScram\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196\"\n}", + "GetBootstrapBrokersResponse$BootstrapBrokerStringPublicSaslIam" : "

A string that contains one or more DNS names (or IP addresses) and SASL IAM port pairs. The following is an example.

{\n \"BootstrapBrokerStringSaslIam\": \"b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198\"\n}", + "KafkaVersion$Version" : "

The Apache Kafka version.

", "ListClusterOperationsResponse$NextToken" : "

If the response of ListClusterOperations is truncated, it returns a NextToken in the response. This Nexttoken should be sent in the subsequent request to ListClusterOperations.

", "ListClustersResponse$NextToken" : "

The paginated results marker. When the result of a ListClusters operation is truncated, the call returns NextToken in the response. To get another batch of clusters, provide this token in your next request.

", "ListConfigurationRevisionsResponse$NextToken" : "

Paginated results marker.

", @@ -760,6 +786,7 @@ "NodeInfo$AddedToClusterTime" : "

The start time.

", "NodeInfo$InstanceType" : "

The instance type.

", "NodeInfo$NodeARN" : "

The Amazon Resource Name (ARN) of the node.

", + "PublicAccess$Type" : "

The value DISABLED indicates that public access is disabled. SERVICE_PROVIDED_EIPS indicates that public access is enabled.

", "RebootBrokerResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", "RebootBrokerResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", "S3$Bucket" : "

The name of the S3 bucket that is the destination for broker logs.

", @@ -779,11 +806,14 @@ "UpdateConfigurationRequest$Description" : "

The description of the configuration.

", "UpdateConfigurationRequest$Arn" : "

The Amazon Resource Name (ARN) of the configuration.

", "UpdateConfigurationResponse$Arn" : "

The Amazon Resource Name (ARN) of the configuration.

", + "UpdateConnectivityRequest$CurrentVersion" : "

The current version of the cluster.

", + "UpdateConnectivityResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", + "UpdateConnectivityResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", "UpdateClusterConfigurationRequest$CurrentVersion" : "

The version of the cluster that you want to update.

", "UpdateClusterConfigurationResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", "UpdateClusterConfigurationResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", "UpdateClusterKafkaVersionRequest$CurrentVersion" : "

Current cluster version.

", - "UpdateClusterKafkaVersionRequest$TargetKafkaVersion" : "

Target Kafka version.

", + "UpdateClusterKafkaVersionRequest$TargetKafkaVersion" : "

Target Apache Kafka version.

", "UpdateClusterKafkaVersionResponse$ClusterArn" : "

The Amazon Resource Name (ARN) of the cluster.

", "UpdateClusterKafkaVersionResponse$ClusterOperationArn" : "

The Amazon Resource Name (ARN) of the cluster operation.

", "UpdateMonitoringRequest$CurrentVersion" : "

The version of cluster to update from. A successful operation will then generate a new version.

", diff --git a/models/apis/lambda/2015-03-31/api-2.json b/models/apis/lambda/2015-03-31/api-2.json index d1bdef9e8a..2530c14239 100644 --- a/models/apis/lambda/2015-03-31/api-2.json +++ b/models/apis/lambda/2015-03-31/api-2.json @@ -3287,7 +3287,9 @@ "VPC_SECURITY_GROUP", "SASL_SCRAM_512_AUTH", "SASL_SCRAM_256_AUTH", - "VIRTUAL_HOST" + "VIRTUAL_HOST", + "CLIENT_CERTIFICATE_TLS_AUTH", + "SERVER_ROOT_CA_CERTIFICATE" ] }, "SourceOwner":{ diff --git a/models/apis/lambda/2015-03-31/docs-2.json b/models/apis/lambda/2015-03-31/docs-2.json index 91cc6ffb12..c15027e8d1 100644 --- a/models/apis/lambda/2015-03-31/docs-2.json +++ b/models/apis/lambda/2015-03-31/docs-2.json @@ -1,12 +1,12 @@ { "version": "2.0", - "service": "Lambda

Overview

This is the Lambda API Reference. The Lambda Developer Guide provides additional information. For the service overview, see What is Lambda, and for information about how the service works, see Lambda: How it Works in the Lambda Developer Guide.

", + "service": "Lambda

Overview

Lambda is a compute service that lets you run code without provisioning or managing servers. Lambda runs your code on a high-availability compute infrastructure and performs all of the administration of the compute resources, including server and operating system maintenance, capacity provisioning and automatic scaling, code monitoring and logging. With Lambda, you can run code for virtually any type of application or backend service. For more information about the Lambda service, see What is Lambda in the Lambda Developer Guide.

The Lambda API Reference provides information about each of the API methods, including details about the parameters in each API request and response.

You can use Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools to access the API. For installation instructions, see Tools for Amazon Web Services.

For a list of Region-specific endpoints that Lambda supports, see Lambda endpoints and quotas in the Amazon Web Services General Reference..

When making the API calls, you will need to authenticate your request by providing a signature. Lambda supports signature version 4. For more information, see Signature Version 4 signing process in the Amazon Web Services General Reference..

CA certificates

Because Amazon Web Services SDKs use the CA certificates from your computer, changes to the certificates on the Amazon Web Services servers can cause connection failures when you attempt to use an SDK. You can prevent these failures by keeping your computer's CA certificates and operating system up-to-date. If you encounter this issue in a corporate environment and do not manage your own computer, you might need to ask an administrator to assist with the update process. The following list shows minimum operating system and Java versions:

When accessing the Lambda management console or Lambda API endpoints, whether through browsers or programmatically, you will need to ensure your client machines support any of the following CAs:

Root certificates from the first two authorities are available from Amazon trust services, but keeping your computer up-to-date is the more straightforward solution. To learn more about ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs.

", "operations": { "AddLayerVersionPermission": "

Adds permissions to the resource-based policy of a version of an Lambda layer. Use this action to grant layer usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, or all Amazon Web Services accounts.

To revoke permission, call RemoveLayerVersionPermission with the statement ID that you specified when you added it.

", "AddPermission": "

Grants an Amazon Web Services service or another account permission to use a function. You can apply the policy at the function level, or specify a qualifier to restrict access to a single version or alias. If you use a qualifier, the invoker must use the full Amazon Resource Name (ARN) of that version or alias to invoke the function. Note: Lambda does not support adding policies to version $LATEST.

To grant permission to another account, specify the account ID as the Principal. For Amazon Web Services services, the principal is a domain-style identifier defined by the service, like s3.amazonaws.com or sns.amazonaws.com. For Amazon Web Services services, you can also specify the ARN of the associated resource as the SourceArn. If you grant permission to a service principal without specifying the source, other accounts could potentially configure resources in their account to invoke your Lambda function.

This action adds a statement to a resource-based permissions policy for the function. For more information about function policies, see Lambda Function Policies.

", "CreateAlias": "

Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.

You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.

", "CreateCodeSigningConfig": "

Creates a code signing configuration. A code signing configuration defines a list of allowed signing profiles and defines the code-signing validation policy (action to be taken if deployment validation checks fail).

", - "CreateEventSourceMapping": "

Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and triggers the function.

For details about each event source type, see the following topics.

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

", + "CreateEventSourceMapping": "

Creates a mapping between an event source and an Lambda function. Lambda reads items from the event source and triggers the function.

For details about how to configure different event sources, see the following topics.

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

For information about which configuration parameters apply to each event source, see the following topics.

", "CreateFunction": "

Creates a Lambda function. To create a function, you need a deployment package and an execution role. The deployment package is a .zip file archive or container image that contains your function code. The execution role grants the function permission to use Amazon Web Services services, such as Amazon CloudWatch Logs for log streaming and X-Ray for request tracing.

You set the package type to Image if the deployment package is a container image. For a container image, the code property must include the URI of a container image in the Amazon ECR registry. You do not need to specify the handler and runtime properties.

You set the package type to Zip if the deployment package is a .zip file archive. For a .zip file archive, the code property specifies the location of the .zip file. You must also specify the handler and runtime properties. The code in the deployment package must be compatible with the target instruction set architecture of the function (x86-64 or arm64). If you do not specify the architecture, the default value is x86-64.

When you create a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute or so. During this time, you can't invoke or modify the function. The State, StateReason, and StateReasonCode fields in the response from GetFunctionConfiguration indicate when the function is ready to invoke. For more information, see Function States.

A function has an unpublished version, and can have published versions and aliases. The unpublished version changes when you update your function's code and configuration. A published version is a snapshot of your function code and configuration that can't be changed. An alias is a named resource that maps to a version, and can be changed to map to a different version. Use the Publish parameter to create version 1 of your function from its initial configuration.

The other parameters let you configure version-specific and function-level settings. You can modify version-specific settings later with UpdateFunctionConfiguration. Function-level settings apply to both the unpublished and published versions of the function, and include tags (TagResource) and per-function concurrency limits (PutFunctionConcurrency).

You can use code signing if your deployment package is a .zip file archive. To enable code signing for this function, specify the ARN of a code-signing configuration. When a user attempts to deploy a code package with UpdateFunctionCode, Lambda checks that the code package has a valid signature from a trusted publisher. The code-signing configuration includes set set of signing profiles, which define the trusted publishers for this function.

If another account or an Amazon Web Services service invokes your function, use AddPermission to grant permission by creating a resource-based IAM policy. You can grant permissions at the function level, on a version, or on an alias.

To invoke your function directly, use Invoke. To invoke your function in response to events in other Amazon Web Services services, create an event source mapping (CreateEventSourceMapping), or configure a function trigger in the other service. For more information, see Invoking Functions.

", "DeleteAlias": "

Deletes a Lambda function alias.

", "DeleteCodeSigningConfig": "

Deletes the code signing configuration. You can delete the code signing configuration only if no function is using it.

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

Removes tags from a function.

", "UpdateAlias": "

Updates the configuration of a Lambda function alias.

", "UpdateCodeSigningConfig": "

Update the code signing configuration. Changes to the code signing configuration take effect the next time a user tries to deploy a code package to the function.

", - "UpdateEventSourceMapping": "

Updates an event source mapping. You can change the function that Lambda invokes, or pause invocation and resume later from the same location.

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

", + "UpdateEventSourceMapping": "

Updates an event source mapping. You can change the function that Lambda invokes, or pause invocation and resume later from the same location.

For details about how to configure different event sources, see the following topics.

The following error handling options are only available for stream sources (DynamoDB and Kinesis):

For information about which configuration parameters apply to each event source, see the following topics.

", "UpdateFunctionCode": "

Updates a Lambda function's code. If code signing is enabled for the function, the code package must be signed by a trusted publisher. For more information, see Configuring code signing.

The function's code is locked when you publish a version. You can't modify the code of a published version, only the unpublished version.

For a function defined as a container image, Lambda resolves the image tag to an image digest. In Amazon ECR, if you update the image tag to a new image, Lambda does not automatically update the function.

", "UpdateFunctionConfiguration": "

Modify the version-specific settings of a Lambda function.

When you update a function, Lambda provisions an instance of the function and its supporting resources. If your function connects to a VPC, this process can take a minute. During this time, you can't modify the function, but you can still invoke it. The LastUpdateStatus, LastUpdateStatusReason, and LastUpdateStatusReasonCode fields in the response from GetFunctionConfiguration indicate when the update is complete and the function is processing events with the new configuration. For more information, see Function States.

These settings can vary between versions of a function and are locked when you publish a version. You can't modify the configuration of a published version, only the unpublished version.

To configure function concurrency, use PutFunctionConcurrency. To grant invoke permissions to an account or Amazon Web Services service, use AddPermission.

", "UpdateFunctionEventInvokeConfig": "

Updates the configuration for asynchronous invocation for a function, version, or alias.

To configure options for asynchronous invocation, use PutFunctionEventInvokeConfig.

" @@ -162,9 +162,9 @@ "ArchitecturesList": { "base": null, "refs": { - "CreateFunctionRequest$Architectures": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values. The default value is x86_64.

", + "CreateFunctionRequest$Architectures": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

", "FunctionConfiguration$Architectures": "

The instruction set architecture that the function supports. Architecture is a string array with one of the valid values. The default architecture value is x86_64.

", - "UpdateFunctionCodeRequest$Architectures": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values. The default value is x86_64.

" + "UpdateFunctionCodeRequest$Architectures": "

The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is x86_64.

" } }, "Arn": { @@ -184,9 +184,9 @@ "BatchSize": { "base": null, "refs": { - "CreateEventSourceMappingRequest$BatchSize": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

", + "CreateEventSourceMappingRequest$BatchSize": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

", "EventSourceMappingConfiguration$BatchSize": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

Default value: Varies by service. For Amazon SQS, the default is 10. For all other services, the default is 100.

Related setting: When you set BatchSize to a value greater than 10, you must set MaximumBatchingWindowInSeconds to at least 1.

", - "UpdateEventSourceMappingRequest$BatchSize": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

" + "UpdateEventSourceMappingRequest$BatchSize": "

The maximum number of records in each batch that Lambda pulls from your stream or queue and sends to your function. Lambda passes all of the records in the batch to the function in a single call, up to the payload limit for synchronous invocation (6 MB).

" } }, "BisectBatchOnFunctionError": { @@ -201,7 +201,7 @@ "base": null, "refs": { "FunctionCode$ZipFile": "

The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.

", - "InvocationRequest$Payload": "

The JSON that you want to provide to your Lambda function as input.

", + "InvocationRequest$Payload": "

The JSON that you want to provide to your Lambda function as input.

You can enter the JSON directly. For example, --payload '{ \"key\": \"value\" }'. You can also specify a file path. For example, --payload file://payload.json.

", "InvocationResponse$Payload": "

The response from the function, or an error object.

", "LayerVersionContentInput$ZipFile": "

The base64-encoded contents of the layer archive. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.

", "UpdateFunctionCodeRequest$ZipFile": "

The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.

" @@ -598,7 +598,7 @@ "AliasConfiguration$AliasArn": "

The Amazon Resource Name (ARN) of the alias.

", "EventSourceMappingConfiguration$FunctionArn": "

The ARN of the Lambda function.

", "FunctionArnList$member": null, - "FunctionConfiguration$MasterArn": "

For Lambda@Edge functions, the ARN of the master function.

", + "FunctionConfiguration$MasterArn": "

For Lambda@Edge functions, the ARN of the main function.

", "FunctionEventInvokeConfig$FunctionArn": "

The Amazon Resource Name (ARN) of the function.

", "ListTagsRequest$Resource": "

The function's Amazon Resource Name (ARN). Note: Lambda does not support adding tags to aliases or versions.

", "ProvisionedConcurrencyConfigListItem$FunctionArn": "

The Amazon Resource Name (ARN) of the alias or version.

", @@ -943,7 +943,7 @@ "base": null, "refs": { "CreateFunctionRequest$KMSKeyArn": "

The ARN of the Amazon Web Services Key Management Service (KMS) key that's used to encrypt your function's environment variables. If it's not provided, Lambda uses a default service key.

", - "FunctionConfiguration$KMSKeyArn": "

The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed CMK.

", + "FunctionConfiguration$KMSKeyArn": "

The KMS key that's used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed key.

", "UpdateFunctionConfigurationRequest$KMSKeyArn": "

The ARN of the Amazon Web Services Key Management Service (KMS) key that's used to encrypt your function's environment variables. If it's not provided, Lambda uses a default service key.

" } }, @@ -1654,7 +1654,7 @@ "SourceAccessType": { "base": null, "refs": { - "SourceAccessConfiguration$Type": "

The type of authentication protocol, VPC components, or virtual host for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".

" + "SourceAccessConfiguration$Type": "

The type of authentication protocol, VPC components, or virtual host for your event source. For example: \"Type\":\"SASL_SCRAM_512_AUTH\".

" } }, "SourceOwner": { @@ -1896,9 +1896,9 @@ "Timeout": { "base": null, "refs": { - "CreateFunctionRequest$Timeout": "

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For additional information, see Lambda execution environment.

", + "CreateFunctionRequest$Timeout": "

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For additional information, see Lambda execution environment.

", "FunctionConfiguration$Timeout": "

The amount of time in seconds that Lambda allows a function to run before stopping it.

", - "UpdateFunctionConfigurationRequest$Timeout": "

The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For additional information, see Lambda execution environment.

" + "UpdateFunctionConfigurationRequest$Timeout": "

The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For additional information, see Lambda execution environment.

" } }, "Timestamp": { diff --git a/models/apis/models.lex.v2/2020-08-07/api-2.json b/models/apis/models.lex.v2/2020-08-07/api-2.json index 1e435b261d..6dd8ad82ec 100644 --- a/models/apis/models.lex.v2/2020-08-07/api-2.json +++ b/models/apis/models.lex.v2/2020-08-07/api-2.json @@ -4638,12 +4638,20 @@ "max":140, "min":1 }, + "VoiceEngine":{ + "type":"string", + "enum":[ + "standard", + "neural" + ] + }, "VoiceId":{"type":"string"}, "VoiceSettings":{ "type":"structure", "required":["voiceId"], "members":{ - "voiceId":{"shape":"VoiceId"} + "voiceId":{"shape":"VoiceId"}, + "engine":{"shape":"VoiceEngine"} } }, "WaitAndContinueSpecification":{ diff --git a/models/apis/models.lex.v2/2020-08-07/docs-2.json b/models/apis/models.lex.v2/2020-08-07/docs-2.json index 2a82665cb8..2fe2e3a180 100644 --- a/models/apis/models.lex.v2/2020-08-07/docs-2.json +++ b/models/apis/models.lex.v2/2020-08-07/docs-2.json @@ -17,7 +17,7 @@ "DeleteBot": "

Deletes all versions of a bot, including the Draft version. To delete a specific version, use the DeleteBotVersion operation.

When you delete a bot, all of the resources contained in the bot are also deleted. Deleting a bot removes all locales, intents, slot, and slot types defined for the bot.

If a bot has an alias, the DeleteBot operation returns a ResourceInUseException exception. If you want to delete the bot and the alias, set the skipResourceInUseCheck parameter to true.

", "DeleteBotAlias": "

Deletes the specified bot alias.

", "DeleteBotLocale": "

Removes a locale from a bot.

When you delete a locale, all intents, slots, and slot types defined for the locale are also deleted.

", - "DeleteBotVersion": "

Deletes a specific version of a bot. To delete all version of a bot, use the DeleteBot operation.

", + "DeleteBotVersion": "

Deletes a specific version of a bot. To delete all version of a bot, use the DeleteBot operation.

", "DeleteExport": "

Removes a previous export and the associated files stored in an S3 bucket.

", "DeleteImport": "

Removes a previous import and the associated file stored in an S3 bucket.

", "DeleteIntent": "

Removes the specified intent.

Deleting an intent also deletes the slots associated with the intent.

", @@ -25,7 +25,7 @@ "DeleteResourcePolicyStatement": "

Deletes a policy statement from a resource policy. If you delete the last statement from a policy, the policy is deleted. If you specify a statement ID that doesn't exist in the policy, or if the bot or bot alias doesn't have a policy attached, Amazon Lex returns an exception.

", "DeleteSlot": "

Deletes the specified slot from an intent.

", "DeleteSlotType": "

Deletes a slot type from a bot locale.

If a slot is using the slot type, Amazon Lex throws a ResourceInUseException exception. To avoid the exception, set the skipResourceInUseCheck parameter to true.

", - "DeleteUtterances": "

Deletes stored utterances.

Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input..

Use the DeleteUtterances operation to manually delete utterances for a specific session. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the ListAggregatedUtterances operation are deleted after 15 days.

", + "DeleteUtterances": "

Deletes stored utterances.

Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the ListAggregatedUtterances operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input..

Use the DeleteUtterances operation to manually delete utterances for a specific session. When you use the DeleteUtterances operation, utterances stored for improving your bot's ability to respond to user input are deleted immediately. Utterances stored for use with the ListAggregatedUtterances operation are deleted after 15 days.

", "DescribeBot": "

Provides metadata information about a bot.

", "DescribeBotAlias": "

Get information about a specific bot alias.

", "DescribeBotLocale": "

Describes the settings that a bot has for a specific locale.

", @@ -41,7 +41,7 @@ "ListBotLocales": "

Gets a list of locales for the specified bot.

", "ListBotVersions": "

Gets information about all of the versions of a bot.

The ListBotVersions operation returns a summary of each version of a bot. For example, if a bot has three numbered versions, the ListBotVersions operation returns for summaries, one for each numbered version and one for the DRAFT version.

The ListBotVersions operation always returns at least one version, the DRAFT version.

", "ListBots": "

Gets a list of available bots.

", - "ListBuiltInIntents": "

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature parameter when you call the CreateIntent operation. For more information, see CreateIntent.

", + "ListBuiltInIntents": "

Gets a list of built-in intents provided by Amazon Lex that you can use in your bot.

To use a built-in intent as a the base for your own intent, include the built-in intent signature in the parentIntentSignature parameter when you call the CreateIntent operation. For more information, see CreateIntent.

", "ListBuiltInSlotTypes": "

Gets a list of built-in slot types that meet the specified criteria.

", "ListExports": "

Lists the exports for a bot or bot locale. Exports are kept in the list for 7 days.

", "ListImports": "

Lists the imports for a bot or bot locale. Imports are kept in the list for 7 days.

", @@ -55,7 +55,7 @@ "UpdateBot": "

Updates the configuration of an existing bot.

", "UpdateBotAlias": "

Updates the configuration of an existing bot alias.

", "UpdateBotLocale": "

Updates the settings that a bot has for a specific locale.

", - "UpdateExport": "

Updates the password used to protect an export zip archive.

The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the operation.

", + "UpdateExport": "

Updates the password used to protect an export zip archive.

The password is not required. If you don't supply a password, Amazon Lex generates a zip file that is not protected by a password. This is the archive that is available at the pre-signed S3 URL provided by the DescribeExport operation.

", "UpdateIntent": "

Updates the settings for an intent.

", "UpdateResourcePolicy": "

Replaces the existing resource policy for a bot or bot alias with a new one. If the policy doesn't exist, Amazon Lex returns an exception.

", "UpdateSlot": "

Updates the settings for a slot.

", @@ -189,7 +189,7 @@ "BotAliasId": { "base": null, "refs": { - "BotAliasSummary$botAliasId": "

The unique identifier assigned to the bot alias. You can use this ID to get detailed information about the alias using the DescribeBotAlias operation.

", + "BotAliasSummary$botAliasId": "

The unique identifier assigned to the bot alias. You can use this ID to get detailed information about the alias using the DescribeBotAlias operation.

", "CreateBotAliasResponse$botAliasId": "

The unique identifier of the bot alias.

", "DeleteBotAliasRequest$botAliasId": "

The unique identifier of the bot alias to delete.

", "DeleteBotAliasResponse$botAliasId": "

The unique identifier of the bot alias to delete.

", @@ -228,7 +228,7 @@ } }, "BotAliasSummary": { - "base": "

Summary information about bot aliases returned from the ListBotAliases operation.

", + "base": "

Summary information about bot aliases returned from the ListBotAliases operation.

", "refs": { "BotAliasSummaryList$member": null } @@ -353,7 +353,7 @@ } }, "BotLocaleSummary": { - "base": "

Summary information about bot locales returned by the ListBotLocales operation.

", + "base": "

Summary information about bot locales returned by the ListBotLocales operation.

", "refs": { "BotLocaleSummaryList$member": null } @@ -391,7 +391,7 @@ } }, "BotSummary": { - "base": "

Summary information about a bot returned by the ListBots operation.

", + "base": "

Summary information about a bot returned by the ListBots operation.

", "refs": { "BotSummaryList$member": null } @@ -461,7 +461,7 @@ } }, "BotVersionSummary": { - "base": "

Summary information about a bot version returned by the ListBotVersions operation.

", + "base": "

Summary information about a bot version returned by the ListBotVersions operation.

", "refs": { "BotVersionSummaryList$member": null } @@ -510,7 +510,7 @@ } }, "BuiltInIntentSummary": { - "base": "

Provides summary information about a built-in intent for the ListBuiltInIntents operation.

", + "base": "

Provides summary information about a built-in intent for the ListBuiltInIntents operation.

", "refs": { "BuiltInIntentSummaryList$member": null } @@ -545,7 +545,7 @@ } }, "BuiltInSlotTypeSummary": { - "base": "

Provides summary information about a built-in slot type for the ListBuiltInSlotTypes operation.

", + "base": "

Provides summary information about a built-in slot type for the ListBuiltInSlotTypes operation.

", "refs": { "BuiltInSlotTypeSummaryList$member": null } @@ -1132,7 +1132,7 @@ } }, "ExportFilter": { - "base": "

Filters the response form the operation

", + "base": "

Filters the response form the ListExports operation

", "refs": { "ExportFilters$member": null } @@ -1180,8 +1180,8 @@ "ExportStatus": { "base": null, "refs": { - "CreateExportResponse$exportStatus": "

The status of the export. When the status is Completed, you can use the operation to get the pre-signed S3 URL link to your exported bot or bot locale.

", - "DeleteExportResponse$exportStatus": "

The current status of the deletion. When the deletion is complete, the export will no longer be returned by the operation and calls to the with the export identifier will fail.

", + "CreateExportResponse$exportStatus": "

The status of the export. When the status is Completed, you can use the DescribeExport operation to get the pre-signed S3 URL link to your exported bot or bot locale.

", + "DeleteExportResponse$exportStatus": "

The current status of the deletion. When the deletion is complete, the export will no longer be returned by the ListExports operation and calls to the DescribeExport operation with the export identifier will fail.

", "DescribeExportResponse$exportStatus": "

The status of the export. When the status is Complete the export archive file is available for download.

", "ExportSummary$exportStatus": "

The status of the export. When the status is Completed the export is ready to download.

", "UpdateExportResponse$exportStatus": "

The status of the export. When the status is Completed the export archive is available for download.

" @@ -1292,8 +1292,8 @@ "BotExportSpecification$botId": "

The identifier of the bot assigned by Amazon Lex.

", "BotLocaleExportSpecification$botId": "

The identifier of the bot to create the locale for.

", "BotLocaleImportSpecification$botId": "

The identifier of the bot to import the locale to.

", - "BotSummary$botId": "

The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the DescribeBot operation.

", - "BuildBotLocaleRequest$botId": "

The identifier of the bot to build. The identifier is returned in the response from the operation.

", + "BotSummary$botId": "

The unique identifier assigned to the bot. Use this ID to get detailed information about the bot with the DescribeBot operation.

", + "BuildBotLocaleRequest$botId": "

The identifier of the bot to build. The identifier is returned in the response from the CreateBot operation.

", "BuildBotLocaleResponse$botId": "

The identifier of the specified bot.

", "CreateBotAliasRequest$botId": "

The unique identifier of the bot that the alias applies to.

", "CreateBotAliasResponse$botId": "

The unique identifier of the bot that this alias applies to.

", @@ -1314,7 +1314,7 @@ "CreateSlotTypeRequest$botId": "

The identifier of the bot associated with this slot type.

", "CreateSlotTypeResponse$slotTypeId": "

The unique identifier assigned to the slot type. Use this to identify the slot type in the UpdateSlotType and DeleteSlotType operations.

", "CreateSlotTypeResponse$botId": "

The identifier for the bot associated with the slot type.

", - "CreateUploadUrlResponse$importId": "

An identifier for a unique import job. Use it when you call the operation.

", + "CreateUploadUrlResponse$importId": "

An identifier for a unique import job. Use it when you call the StartImport operation.

", "DeleteBotAliasRequest$botId": "

The unique identifier of the bot associated with the alias to delete.

", "DeleteBotAliasResponse$botId": "

The unique identifier of the bot that contains the alias to delete.

", "DeleteBotLocaleRequest$botId": "

The unique identifier of the bot that contains the locale.

", @@ -1387,13 +1387,13 @@ "SlotPriority$slotId": "

The unique identifier of the slot.

", "SlotSummary$slotId": "

The unique identifier of the slot.

", "SlotTypeSummary$slotTypeId": "

The unique identifier assigned to the slot type.

", - "StartImportRequest$importId": "

The unique identifier for the import. It is included in the response from the operation.

", + "StartImportRequest$importId": "

The unique identifier for the import. It is included in the response from the CreateUploadUrl operation.

", "StartImportResponse$importId": "

A unique identifier for the import.

", "UpdateBotAliasRequest$botId": "

The identifier of the bot with the updated alias.

", "UpdateBotAliasResponse$botId": "

The identifier of the bot with the updated alias.

", "UpdateBotLocaleRequest$botId": "

The unique identifier of the bot that contains the locale.

", "UpdateBotLocaleResponse$botId": "

The identifier of the bot that contains the updated locale.

", - "UpdateBotRequest$botId": "

The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.

", + "UpdateBotRequest$botId": "

The unique identifier of the bot to update. This identifier is returned by the CreateBot operation.

", "UpdateBotResponse$botId": "

The unique identifier of the bot that was updated.

", "UpdateExportRequest$exportId": "

The unique identifier Amazon Lex assigned to the export.

", "UpdateExportResponse$exportId": "

The unique identifier Amazon Lex assigned to the export.

", @@ -1438,7 +1438,7 @@ } }, "ImportFilter": { - "base": "

Filters the response from the operation.

", + "base": "

Filters the response from the ListImports operation.

", "refs": { "ImportFilters$member": null } @@ -1484,7 +1484,7 @@ "ImportStatus": { "base": null, "refs": { - "DeleteImportResponse$importStatus": "

The current status of the deletion. When the deletion is complete, the import will no longer be returned by the operation and calls to the with the import identifier will fail.

", + "DeleteImportResponse$importStatus": "

The current status of the deletion. When the deletion is complete, the import will no longer be returned by the ListImports operation and calls to the DescribeImport operation with the import identifier will fail.

", "DescribeImportResponse$importStatus": "

The status of the import process. When the status is Completed the resource is imported and ready for use.

", "ImportSummary$importStatus": "

The status of the resource. When the status is Completed the resource is ready to build.

", "StartImportResponse$importStatus": "

The current status of the import. When the status is Complete the bot or bot alias is ready to use.

" @@ -1991,7 +1991,7 @@ "base": null, "refs": { "BotSummary$latestBotVersion": "

The latest numerical version in use for the bot.

", - "CreateBotAliasRequest$botVersion": "

The version of the bot that this alias points to. You can use the operation to change the bot version associated with the alias.

", + "CreateBotAliasRequest$botVersion": "

The version of the bot that this alias points to. You can use the UpdateBotAlias operation to change the bot version associated with the alias.

", "CreateBotAliasResponse$botVersion": "

The version of the bot associated with this alias.

", "CreateBotVersionResponse$botVersion": "

The version number assigned to the version.

", "DeleteBotVersionRequest$botVersion": "

The version of the bot to delete.

", @@ -2205,7 +2205,7 @@ "S3BucketLogDestination": { "base": "

Specifies an Amazon S3 bucket for logging audio conversations

", "refs": { - "AudioLogDestination$s3Bucket": "

The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn parameter of the CreateBot operation must have permission to write to this bucket.

" + "AudioLogDestination$s3Bucket": "

The Amazon S3 bucket where the audio log files are stored. The IAM role specified in the roleArn parameter of the CreateBot operation must have permission to write to this bucket.

" } }, "SSMLMessage": { @@ -2268,7 +2268,7 @@ "SessionId": { "base": null, "refs": { - "DeleteUtterancesRequest$sessionId": "

The unique identifier of the session with the user. The ID is returned in the response from the and operations.

" + "DeleteUtterancesRequest$sessionId": "

The unique identifier of the session with the user. The ID is returned in the response from the RecognizeText and RecognizeUtterance operations.

" } }, "SessionTTL": { @@ -2805,6 +2805,12 @@ "SampleValue$value": "

The value that can be used for a slot type.

" } }, + "VoiceEngine": { + "base": null, + "refs": { + "VoiceSettings$engine": "

Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more information, see Voices in Amazon Polly.

" + } + }, "VoiceId": { "base": null, "refs": { diff --git a/models/apis/monitoring/2010-08-01/api-2.json b/models/apis/monitoring/2010-08-01/api-2.json index 02d288aecc..2d58079b9d 100644 --- a/models/apis/monitoring/2010-08-01/api-2.json +++ b/models/apis/monitoring/2010-08-01/api-2.json @@ -38,7 +38,8 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceFault"}, {"shape":"InvalidParameterValueException"}, - {"shape":"MissingRequiredParameterException"} + {"shape":"MissingRequiredParameterException"}, + {"shape":"InvalidParameterCombinationException"} ] }, "DeleteDashboards":{ @@ -147,7 +148,8 @@ "errors":[ {"shape":"InvalidNextToken"}, {"shape":"InternalServiceFault"}, - {"shape":"InvalidParameterValueException"} + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidParameterCombinationException"} ] }, "DescribeInsightRules":{ @@ -394,7 +396,8 @@ {"shape":"LimitExceededException"}, {"shape":"InternalServiceFault"}, {"shape":"InvalidParameterValueException"}, - {"shape":"MissingRequiredParameterException"} + {"shape":"MissingRequiredParameterException"}, + {"shape":"InvalidParameterCombinationException"} ] }, "PutCompositeAlarm":{ @@ -644,12 +647,30 @@ "AnomalyDetector":{ "type":"structure", "members":{ - "Namespace":{"shape":"Namespace"}, - "MetricName":{"shape":"MetricName"}, - "Dimensions":{"shape":"Dimensions"}, - "Stat":{"shape":"AnomalyDetectorMetricStat"}, + "Namespace":{ + "shape":"Namespace", + "deprecated":true, + "deprecatedMessage":"Use SingleMetricAnomalyDetector.Namespace property." + }, + "MetricName":{ + "shape":"MetricName", + "deprecated":true, + "deprecatedMessage":"Use SingleMetricAnomalyDetector.MetricName property." + }, + "Dimensions":{ + "shape":"Dimensions", + "deprecated":true, + "deprecatedMessage":"Use SingleMetricAnomalyDetector.Dimensions property." + }, + "Stat":{ + "shape":"AnomalyDetectorMetricStat", + "deprecated":true, + "deprecatedMessage":"Use SingleMetricAnomalyDetector.Stat property." + }, "Configuration":{"shape":"AnomalyDetectorConfiguration"}, - "StateValue":{"shape":"AnomalyDetectorStateValue"} + "StateValue":{"shape":"AnomalyDetectorStateValue"}, + "SingleMetricAnomalyDetector":{"shape":"SingleMetricAnomalyDetector"}, + "MetricMathAnomalyDetector":{"shape":"MetricMathAnomalyDetector"} } }, "AnomalyDetectorConfiguration":{ @@ -665,7 +686,8 @@ }, "AnomalyDetectorMetricStat":{ "type":"string", - "pattern":"(SampleCount|Average|Sum|Minimum|Maximum|p(\\d{1,2}|100)(\\.\\d{0,2})?|[ou]\\d+(\\.\\d*)?)(_E|_L|_H)?" + "max":50, + "pattern":"(SampleCount|Average|Sum|Minimum|Maximum|IQM|(p|tc|tm|ts|wm)(\\d{1,2}(\\.\\d{0,10})?|100)|[ou]\\d+(\\.\\d*)?)(_E|_L|_H)?|(TM|TC|TS|WM)\\(((((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%)?:((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%|((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%:(((\\d{1,2})(\\.\\d{0,10})?|100(\\.0{0,10})?)%)?)\\)|(TM|TC|TS|WM|PR)\\(((\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)):((\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)))?|((\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)))?:(\\d+(\\.\\d{0,10})?|(\\d+(\\.\\d{0,10})?[Ee][+-]?\\d+)))\\)" }, "AnomalyDetectorMetricTimezone":{ "type":"string", @@ -680,6 +702,18 @@ "TRAINED" ] }, + "AnomalyDetectorType":{ + "type":"string", + "enum":[ + "SINGLE_METRIC", + "METRIC_MATH" + ] + }, + "AnomalyDetectorTypes":{ + "type":"list", + "member":{"shape":"AnomalyDetectorType"}, + "max":2 + }, "AnomalyDetectors":{ "type":"list", "member":{"shape":"AnomalyDetector"} @@ -862,16 +896,29 @@ }, "DeleteAnomalyDetectorInput":{ "type":"structure", - "required":[ - "Namespace", - "MetricName", - "Stat" - ], "members":{ - "Namespace":{"shape":"Namespace"}, - "MetricName":{"shape":"MetricName"}, - "Dimensions":{"shape":"Dimensions"}, - "Stat":{"shape":"AnomalyDetectorMetricStat"} + "Namespace":{ + "shape":"Namespace", + "deprecated":true, + "deprecatedMessage":"Use SingleMetricAnomalyDetector." + }, + "MetricName":{ + "shape":"MetricName", + "deprecated":true, + "deprecatedMessage":"Use SingleMetricAnomalyDetector." + }, + "Dimensions":{ + "shape":"Dimensions", + "deprecated":true, + "deprecatedMessage":"Use SingleMetricAnomalyDetector." + }, + "Stat":{ + "shape":"AnomalyDetectorMetricStat", + "deprecated":true, + "deprecatedMessage":"Use SingleMetricAnomalyDetector." + }, + "SingleMetricAnomalyDetector":{"shape":"SingleMetricAnomalyDetector"}, + "MetricMathAnomalyDetector":{"shape":"MetricMathAnomalyDetector"} } }, "DeleteAnomalyDetectorOutput":{ @@ -987,7 +1034,8 @@ "MaxResults":{"shape":"MaxReturnedResultsCount"}, "Namespace":{"shape":"Namespace"}, "MetricName":{"shape":"MetricName"}, - "Dimensions":{"shape":"Dimensions"} + "Dimensions":{"shape":"Dimensions"}, + "AnomalyDetectorTypes":{"shape":"AnomalyDetectorTypes"} } }, "DescribeAnomalyDetectorsOutput":{ @@ -1725,6 +1773,12 @@ "min":1 }, "MetricLabel":{"type":"string"}, + "MetricMathAnomalyDetector":{ + "type":"structure", + "members":{ + "MetricDataQueries":{"shape":"MetricDataQueries"} + } + }, "MetricName":{ "type":"string", "max":255, @@ -1831,17 +1885,30 @@ }, "PutAnomalyDetectorInput":{ "type":"structure", - "required":[ - "Namespace", - "MetricName", - "Stat" - ], "members":{ - "Namespace":{"shape":"Namespace"}, - "MetricName":{"shape":"MetricName"}, - "Dimensions":{"shape":"Dimensions"}, - "Stat":{"shape":"AnomalyDetectorMetricStat"}, - "Configuration":{"shape":"AnomalyDetectorConfiguration"} + "Namespace":{ + "shape":"Namespace", + "deprecated":true, + "deprecatedMessage":"Use SingleMetricAnomalyDetector." + }, + "MetricName":{ + "shape":"MetricName", + "deprecated":true, + "deprecatedMessage":"Use SingleMetricAnomalyDetector." + }, + "Dimensions":{ + "shape":"Dimensions", + "deprecated":true, + "deprecatedMessage":"Use SingleMetricAnomalyDetector." + }, + "Stat":{ + "shape":"AnomalyDetectorMetricStat", + "deprecated":true, + "deprecatedMessage":"Use SingleMetricAnomalyDetector." + }, + "Configuration":{"shape":"AnomalyDetectorConfiguration"}, + "SingleMetricAnomalyDetector":{"shape":"SingleMetricAnomalyDetector"}, + "MetricMathAnomalyDetector":{"shape":"MetricMathAnomalyDetector"} } }, "PutAnomalyDetectorOutput":{ @@ -2046,6 +2113,15 @@ "StateReasonData":{"shape":"StateReasonData"} } }, + "SingleMetricAnomalyDetector":{ + "type":"structure", + "members":{ + "Namespace":{"shape":"Namespace"}, + "MetricName":{"shape":"MetricName"}, + "Dimensions":{"shape":"Dimensions"}, + "Stat":{"shape":"AnomalyDetectorMetricStat"} + } + }, "Size":{"type":"long"}, "StandardUnit":{ "type":"string", diff --git a/models/apis/monitoring/2010-08-01/docs-2.json b/models/apis/monitoring/2010-08-01/docs-2.json index 42d5bc7ce6..bf23a10cfe 100644 --- a/models/apis/monitoring/2010-08-01/docs-2.json +++ b/models/apis/monitoring/2010-08-01/docs-2.json @@ -7,10 +7,10 @@ "DeleteDashboards": "

Deletes all dashboards that you specify. You can specify up to 100 dashboards to delete. If there is an error during this call, no dashboards are deleted.

", "DeleteInsightRules": "

Permanently deletes the specified Contributor Insights rules.

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

", "DeleteMetricStream": "

Permanently deletes the metric stream that you specify.

", - "DescribeAlarmHistory": "

Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

CloudWatch retains the history of an alarm even if you delete the alarm.

", - "DescribeAlarms": "

Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.

", + "DescribeAlarmHistory": "

Retrieves the history for the specified alarm. You can filter the results by date range or item type. If an alarm name is not specified, the histories for either all metric alarms or all composite alarms are returned.

CloudWatch retains the history of an alarm even if you delete the alarm.

To use this operation and return information about a composite alarm, you must be signed on with the cloudwatch:DescribeAlarmHistory permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarmHistory permission has a narrower scope.

", + "DescribeAlarms": "

Retrieves the specified alarms. You can filter the results by specifying a prefix for the alarm name, the alarm state, or a prefix for any action.

To use this operation and return information about composite alarms, you must be signed on with the cloudwatch:DescribeAlarms permission that is scoped to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms permission has a narrower scope.

", "DescribeAlarmsForMetric": "

Retrieves the alarms for the specified metric. To filter the results, specify a statistic, period, or unit.

This operation retrieves only standard alarms that are based on the specified metric. It does not return alarms based on math expressions that use the specified metric, or composite alarms that use the specified metric.

", - "DescribeAnomalyDetectors": "

Lists the anomaly detection models that you have created in your account. You can list all models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension.

", + "DescribeAnomalyDetectors": "

Lists the anomaly detection models that you have created in your account. For single metric anomaly detectors, you can list all of the models in your account or filter the results to only the models that are related to a certain namespace, metric name, or metric dimension. For metric math anomaly detectors, you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. This will return all metric math anomaly detectors in your account.

", "DescribeInsightRules": "

Returns a list of all the Contributor Insights rules in your account.

For more information about Contributor Insights, see Using Contributor Insights to Analyze High-Cardinality Data.

", "DisableAlarmActions": "

Disables the actions for the specified alarms. When an alarm's actions are disabled, the alarm actions do not execute when the alarm state changes.

", "DisableInsightRules": "

Disables the specified Contributor Insights rules. When rules are disabled, they do not analyze log groups and do not incur costs.

", @@ -27,12 +27,12 @@ "ListMetrics": "

List the specified metrics. You can use the returned metrics with GetMetricData or GetMetricStatistics to obtain statistical data.

Up to 500 results are returned for any one call. To retrieve additional results, use the returned token with subsequent calls.

After you create a metric, allow up to 15 minutes before the metric appears. You can see statistics about the metric sooner by using GetMetricData or GetMetricStatistics.

ListMetrics doesn't return information about metrics if those metrics haven't reported data in the past two weeks. To retrieve those metrics, use GetMetricData or GetMetricStatistics.

", "ListTagsForResource": "

Displays the tags associated with a CloudWatch resource. Currently, alarms and Contributor Insights rules support tagging.

", "PutAnomalyDetector": "

Creates an anomaly detection model for a CloudWatch metric. You can use the model to display a band of expected normal values when the metric is graphed.

For more information, see CloudWatch Anomaly Detection.

", - "PutCompositeAlarm": "

Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

If you are an IAM user, you must have iam:CreateServiceLinkedRole to create a composite alarm that has Systems Manager OpsItem actions.

", + "PutCompositeAlarm": "

Creates or updates a composite alarm. When you create a composite alarm, you specify a rule expression for the alarm that takes into account the alarm states of other alarms that you have created. The composite alarm goes into ALARM state only if all conditions of the rule are met.

The alarms specified in a composite alarm's rule expression can include metric alarms and other composite alarms.

Using composite alarms can reduce alarm noise. You can create multiple metric alarms, and also create a composite alarm and set up alerts only for the composite alarm. For example, you could create a composite alarm that goes into ALARM state only when more than one of the underlying metric alarms are in ALARM state.

Currently, the only alarm actions that can be taken by composite alarms are notifying SNS topics.

It is possible to create a loop or cycle of composite alarms, where composite alarm A depends on composite alarm B, and composite alarm B also depends on composite alarm A. In this scenario, you can't delete any composite alarm that is part of the cycle because there is always still a composite alarm that depends on that alarm that you want to delete.

To get out of such a situation, you must break the cycle by changing the rule of one of the composite alarms in the cycle to remove a dependency that creates the cycle. The simplest change to make to break a cycle is to change the AlarmRule of one of the alarms to False.

Additionally, the evaluation of composite alarms stops if CloudWatch detects a cycle in the evaluation path.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. For a composite alarm, this initial time after creation is the only time that the alarm can be in INSUFFICIENT_DATA state.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm permission that is scoped to *. You can't create a composite alarms if your cloudwatch:PutCompositeAlarm permission has a narrower scope.

If you are an IAM user, you must have iam:CreateServiceLinkedRole to create a composite alarm that has Systems Manager OpsItem actions.

", "PutDashboard": "

Creates a dashboard if it does not already exist, or updates an existing dashboard. If you update a dashboard, the entire contents are replaced with what you specify here.

All dashboards in your account are global, not region-specific.

A simple way to create a dashboard using PutDashboard is to copy an existing dashboard. To copy an existing dashboard using the console, you can load the dashboard and then use the View/edit source command in the Actions menu to display the JSON block for that dashboard. Another way to copy a dashboard is to use GetDashboard, and then use the data returned within DashboardBody as the template for the new dashboard when you call PutDashboard.

When you create a dashboard with PutDashboard, a good practice is to add a text widget at the top of the dashboard with a message that the dashboard was created by script and should not be changed in the console. This message could also point console users to the location of the DashboardBody script or the CloudFormation template used to create the dashboard.

", "PutInsightRule": "

Creates a Contributor Insights rule. Rules evaluate log events in a CloudWatch Logs log group, enabling you to find contributor data for the log events in that log group. For more information, see Using Contributor Insights to Analyze High-Cardinality Data.

If you create a rule, delete it, and then re-create it with the same name, historical data from the first time the rule was created might not be available.

", - "PutMetricAlarm": "

Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

Alarms based on anomaly detection models cannot have Auto Scaling actions.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

The first time you create an alarm in the Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents and AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see Amazon Web Services service-linked role.

Cross-account alarms

You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites:

", + "PutMetricAlarm": "

Creates or updates an alarm and associates it with the specified metric, metric math expression, or anomaly detection model.

Alarms based on anomaly detection models cannot have Auto Scaling actions.

When this operation creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed.

When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous configuration of the alarm.

If you are an IAM user, you must have Amazon EC2 permissions for some alarm operations:

The first time you create an alarm in the Amazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents and AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see Amazon Web Services service-linked role.

Cross-account alarms

You can set an alarm on metrics in the current account, or in another account. To create a cross-account alarm that watches a metric in a different account, you must have completed the following pre-requisites:

", "PutMetricData": "

Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metric. If the specified metric does not exist, CloudWatch creates the metric. When CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to ListMetrics.

You can publish either individual data points in the Value field, or arrays of values and the number of times each value occurred during the period by using the Values and Counts fields in the MetricDatum structure. Using the Values and Counts method enables you to publish up to 150 values per metric with one PutMetricData request, and supports retrieving percentile statistics on this data.

Each PutMetricData request is limited to 40 KB in size for HTTP POST requests. You can send a payload compressed by gzip. Each request is also limited to no more than 20 different metrics.

Although the Value parameter accepts numbers of type Double, CloudWatch rejects values that are either too small or too large. Values must be in the range of -2^360 to 2^360. In addition, special values (for example, NaN, +Infinity, -Infinity) are not supported.

You can use up to 10 dimensions per metric to further clarify what data the metric collects. Each dimension consists of a Name and Value pair. For more information about specifying dimensions, see Publishing Metrics in the Amazon CloudWatch User Guide.

You specify the time stamp to be associated with each data point. You can specify time stamps that are as much as two weeks before the current date, and as much as 2 hours after the current day and time.

Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for GetMetricData or GetMetricStatistics from the time they are submitted. Data points with time stamps between 3 and 24 hours ago can take as much as 2 hours to become available for for GetMetricData or GetMetricStatistics.

CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you can only retrieve percentile statistics for this data if one of the following conditions is true:

", - "PutMetricStream": "

Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web Services destinations including Amazon S3 and to many third-party solutions.

For more information, see Using Metric Streams.

To create a metric stream, you must be logged on to an account that has the iam:PassRole permission and either the CloudWatchFullAccess policy or the cloudwatch:PutMetricStream permission.

When you create or update a metric stream, you choose one of the following:

When you use PutMetricStream to create a new metric stream, the stream is created in the running state. If you use it to update an existing stream, the state of the stream is not changed.

", + "PutMetricStream": "

Creates or updates a metric stream. Metric streams can automatically stream CloudWatch metrics to Amazon Web Services destinations including Amazon S3 and to many third-party solutions.

For more information, see Using Metric Streams.

To create a metric stream, you must be logged on to an account that has the iam:PassRole permission and either the CloudWatchFullAccess policy or the cloudwatch:PutMetricStream permission.

When you create or update a metric stream, you choose one of the following:

When you use PutMetricStream to create a new metric stream, the stream is created in the running state. If you use it to update an existing stream, the state of the stream is not changed.

", "SetAlarmState": "

Temporarily sets the state of an alarm for testing purposes. When the updated state differs from the previous value, the action configured for the appropriate state is invoked. For example, if your alarm is configured to send an Amazon SNS message when an alarm is triggered, temporarily changing the alarm state to ALARM sends an SNS message.

Metric alarms returns to their actual state quickly, often within seconds. Because the metric alarm state change happens quickly, it is typically only visible in the alarm's History tab in the Amazon CloudWatch console or through DescribeAlarmHistory.

If you use SetAlarmState on a composite alarm, the composite alarm is not guaranteed to return to its actual state. It returns to its actual state only once any of its children alarms change state. It is also reevaluated if you update its configuration.

If an alarm triggers EC2 Auto Scaling policies or application Auto Scaling policies, you must include information in the StateReasonData parameter to enable the policy to take the correct action.

", "StartMetricStreams": "

Starts the streaming of metrics for one or more of your metric streams.

", "StopMetricStreams": "

Stops the streaming of metrics for one or more of your metric streams.

", @@ -157,7 +157,7 @@ } }, "AnomalyDetector": { - "base": "

An anomaly detection model associated with a particular CloudWatch metric and statistic. You can use the model to display a band of expected normal values when the metric is graphed.

", + "base": "

An anomaly detection model associated with a particular CloudWatch metric, statistic, or metric math expression. You can use the model to display a band of expected, normal values when the metric is graphed.

", "refs": { "AnomalyDetectors$member": null } @@ -180,7 +180,8 @@ "refs": { "AnomalyDetector$Stat": "

The statistic associated with the anomaly detection model.

", "DeleteAnomalyDetectorInput$Stat": "

The statistic associated with the anomaly detection model to delete.

", - "PutAnomalyDetectorInput$Stat": "

The statistic to use for the metric and the anomaly detection model.

" + "PutAnomalyDetectorInput$Stat": "

The statistic to use for the metric and the anomaly detection model.

", + "SingleMetricAnomalyDetector$Stat": "

The statistic to use for the metric and anomaly detection model.

" } }, "AnomalyDetectorMetricTimezone": { @@ -195,6 +196,18 @@ "AnomalyDetector$StateValue": "

The current status of the anomaly detector's training. The possible values are TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA

" } }, + "AnomalyDetectorType": { + "base": null, + "refs": { + "AnomalyDetectorTypes$member": null + } + }, + "AnomalyDetectorTypes": { + "base": null, + "refs": { + "DescribeAnomalyDetectorsInput$AnomalyDetectorTypes": "

The anomaly detector types to request when using DescribeAnomalyDetectorsInput. If empty, defaults to SINGLE_METRIC.

" + } + }, "AnomalyDetectors": { "base": null, "refs": { @@ -520,7 +533,8 @@ "MetricAlarm$Dimensions": "

The dimensions for the metric associated with the alarm.

", "MetricDatum$Dimensions": "

The dimensions associated with the metric.

", "PutAnomalyDetectorInput$Dimensions": "

The metric dimensions to create the anomaly detection model for.

", - "PutMetricAlarmInput$Dimensions": "

The dimensions for the metric specified in MetricName.

" + "PutMetricAlarmInput$Dimensions": "

The dimensions for the metric specified in MetricName.

", + "SingleMetricAnomalyDetector$Dimensions": "

The metric dimensions to create the anomaly detection model for.

" } }, "DisableAlarmActionsInput": { @@ -714,7 +728,7 @@ } }, "InsightRule": { - "base": "

This structure contains the definition for a Contributor Insights rule.

", + "base": "

This structure contains the definition for a Contributor Insights rule. For more information about this rule, see Using Constributor Insights to analyze high-cardinality data in the Amazon CloudWatch User Guide.

", "refs": { "InsightRules$member": null } @@ -836,7 +850,7 @@ "InsightRuleSchema": { "base": null, "refs": { - "InsightRule$Schema": "

For rules that you create, this is always {\"Name\": \"CloudWatchLogRule\", \"Version\": 1}. For built-in rules, this is {\"Name\": \"ServiceLogRule\", \"Version\": 1}

" + "InsightRule$Schema": "

For rules that you create, this is always {\"Name\": \"CloudWatchLogRule\", \"Version\": 1}. For managed rules, this is {\"Name\": \"ServiceLogRule\", \"Version\": 1}

" } }, "InsightRuleState": { @@ -1040,6 +1054,7 @@ "refs": { "GetMetricDataInput$MetricDataQueries": "

The metric queries to be returned. A single GetMetricData call can include as many as 500 MetricDataQuery structures. Each of these structures can specify either a metric to retrieve, or a math expression to perform on retrieved data.

", "MetricAlarm$Metrics": "

An array of MetricDataQuery structures, used in an alarm based on a metric math expression. Each structure either retrieves a metric or performs a math expression. One item in the Metrics array is the math expression that the alarm watches. This expression by designated by having ReturnData set to true.

", + "MetricMathAnomalyDetector$MetricDataQueries": "

An array of metric data query structures that enables you to create an anomaly detector based on the result of a metric math expression. Each item in MetricDataQueries gets a metric or performs a math expression. One item in MetricDataQueries is the expression that provides the time series that the anomaly detector uses as input. Designate the expression by setting ReturnData to True for this object in the array. For all other expressions and metrics, set ReturnData to False. The designated expression must return a single time series.

", "PutMetricAlarmInput$Metrics": "

An array of MetricDataQuery structures that enable you to create an alarm based on the result of a metric math expression. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.

Each item in the Metrics array either retrieves a metric or performs a math expression.

One item in the Metrics array is the expression that the alarm watches. You designate this expression by setting ReturnData to true for this object in the array. For more information, see MetricDataQuery.

If you use the Metrics parameter, you cannot include the MetricName, Dimensions, Period, Namespace, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the Metrics array.

" } }, @@ -1097,6 +1112,14 @@ "MetricDataResult$Label": "

The human-readable label associated with the data.

" } }, + "MetricMathAnomalyDetector": { + "base": "

Indicates the CloudWatch math expression that provides the time series the anomaly detector uses as input. The designated math expression must return a single time series.

", + "refs": { + "AnomalyDetector$MetricMathAnomalyDetector": "

The CloudWatch metric math expression for this anomaly detector.

", + "DeleteAnomalyDetectorInput$MetricMathAnomalyDetector": "

The metric math anomaly detector to be deleted.

When using MetricMathAnomalyDetector, you cannot include following parameters in the same operation:

Instead, specify the metric math anomaly detector attributes as part of the MetricMathAnomalyDetector property.

", + "PutAnomalyDetectorInput$MetricMathAnomalyDetector": "

The metric math anomaly detector to be created.

When using MetricMathAnomalyDetector, you cannot include the following parameters in the same operation:

Instead, specify the metric math anomaly detector attributes as part of the property MetricMathAnomalyDetector.

" + } + }, "MetricName": { "base": null, "refs": { @@ -1110,7 +1133,8 @@ "MetricAlarm$MetricName": "

The name of the metric associated with the alarm, if this is an alarm based on a single metric.

", "MetricDatum$MetricName": "

The name of the metric.

", "PutAnomalyDetectorInput$MetricName": "

The name of the metric to create the anomaly detection model for.

", - "PutMetricAlarmInput$MetricName": "

The name for the metric associated with the alarm. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.

If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the Dimensions, Period, Namespace, Statistic, or ExtendedStatistic parameters. Instead, you specify all this information in the Metrics array.

" + "PutMetricAlarmInput$MetricName": "

The name for the metric associated with the alarm. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.

If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the Dimensions, Period, Namespace, Statistic, or ExtendedStatistic parameters. Instead, you specify all this information in the Metrics array.

", + "SingleMetricAnomalyDetector$MetricName": "

The name of the metric to create the anomaly detection model for.

" } }, "MetricStat": { @@ -1216,7 +1240,8 @@ "MetricStreamFilter$Namespace": "

The name of the metric namespace in the filter.

", "PutAnomalyDetectorInput$Namespace": "

The namespace of the metric to create the anomaly detection model for.

", "PutMetricAlarmInput$Namespace": "

The namespace for the metric associated specified in MetricName.

", - "PutMetricDataInput$Namespace": "

The namespace for the metric data.

To avoid conflicts with Amazon Web Services service namespaces, you should not specify a namespace that begins with AWS/

" + "PutMetricDataInput$Namespace": "

The namespace for the metric data.

To avoid conflicts with Amazon Web Services service namespaces, you should not specify a namespace that begins with AWS/

", + "SingleMetricAnomalyDetector$Namespace": "

The namespace of the metric to create the anomaly detection model for.

" } }, "NextToken": { @@ -1394,6 +1419,14 @@ "refs": { } }, + "SingleMetricAnomalyDetector": { + "base": "

Designates the CloudWatch metric and statistic that provides the time series the anomaly detector uses as input.

", + "refs": { + "AnomalyDetector$SingleMetricAnomalyDetector": "

The CloudWatch metric and statistic for this anomaly detector.

", + "DeleteAnomalyDetectorInput$SingleMetricAnomalyDetector": "

A single metric anomaly detector to be deleted.

When using SingleMetricAnomalyDetector, you cannot include the following parameters in the same operation:

Instead, specify the single metric anomaly detector attributes as part of the SingleMetricAnomalyDetector property.

", + "PutAnomalyDetectorInput$SingleMetricAnomalyDetector": "

A single metric anomaly detector to be created.

When using SingleMetricAnomalyDetector, you cannot include the following parameters in the same operation:

Instead, specify the single metric anomaly detector attributes as part of the property SingleMetricAnomalyDetector.

" + } + }, "Size": { "base": null, "refs": { diff --git a/models/apis/redshift-data/2019-12-20/api-2.json b/models/apis/redshift-data/2019-12-20/api-2.json index 5b491e4601..d5b24234f6 100644 --- a/models/apis/redshift-data/2019-12-20/api-2.json +++ b/models/apis/redshift-data/2019-12-20/api-2.json @@ -38,8 +38,7 @@ "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, - {"shape":"InternalServerException"}, - {"shape":"DatabaseConnectionException"} + {"shape":"InternalServerException"} ] }, "DescribeStatement":{ @@ -66,8 +65,7 @@ "output":{"shape":"DescribeTableResponse"}, "errors":[ {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"DatabaseConnectionException"} + {"shape":"InternalServerException"} ] }, "ExecuteStatement":{ @@ -108,8 +106,7 @@ "output":{"shape":"ListDatabasesResponse"}, "errors":[ {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"DatabaseConnectionException"} + {"shape":"InternalServerException"} ] }, "ListSchemas":{ @@ -122,8 +119,7 @@ "output":{"shape":"ListSchemasResponse"}, "errors":[ {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"DatabaseConnectionException"} + {"shape":"InternalServerException"} ] }, "ListStatements":{ @@ -149,8 +145,7 @@ "output":{"shape":"ListTablesResponse"}, "errors":[ {"shape":"ValidationException"}, - {"shape":"InternalServerException"}, - {"shape":"DatabaseConnectionException"} + {"shape":"InternalServerException"} ] } }, @@ -178,6 +173,7 @@ "BatchExecuteStatementInput":{ "type":"structure", "required":[ + "ClusterIdentifier", "Database", "Sqls" ], @@ -258,15 +254,6 @@ "type":"list", "member":{"shape":"ColumnMetadata"} }, - "DatabaseConnectionException":{ - "type":"structure", - "required":["Message"], - "members":{ - "Message":{"shape":"String"} - }, - "exception":true, - "fault":true - }, "DatabaseList":{ "type":"list", "member":{"shape":"String"} @@ -304,7 +291,10 @@ }, "DescribeTableRequest":{ "type":"structure", - "required":["Database"], + "required":[ + "ClusterIdentifier", + "Database" + ], "members":{ "ClusterIdentifier":{"shape":"Location"}, "ConnectedDatabase":{"shape":"String"}, @@ -341,6 +331,7 @@ "ExecuteStatementInput":{ "type":"structure", "required":[ + "ClusterIdentifier", "Database", "Sql" ], @@ -412,7 +403,10 @@ }, "ListDatabasesRequest":{ "type":"structure", - "required":["Database"], + "required":[ + "ClusterIdentifier", + "Database" + ], "members":{ "ClusterIdentifier":{"shape":"Location"}, "Database":{"shape":"String"}, @@ -431,7 +425,10 @@ }, "ListSchemasRequest":{ "type":"structure", - "required":["Database"], + "required":[ + "ClusterIdentifier", + "Database" + ], "members":{ "ClusterIdentifier":{"shape":"Location"}, "ConnectedDatabase":{"shape":"String"}, @@ -475,7 +472,10 @@ }, "ListTablesRequest":{ "type":"structure", - "required":["Database"], + "required":[ + "ClusterIdentifier", + "Database" + ], "members":{ "ClusterIdentifier":{"shape":"Location"}, "ConnectedDatabase":{"shape":"String"}, diff --git a/models/apis/redshift-data/2019-12-20/docs-2.json b/models/apis/redshift-data/2019-12-20/docs-2.json index 6a76796048..ac61c11891 100644 --- a/models/apis/redshift-data/2019-12-20/docs-2.json +++ b/models/apis/redshift-data/2019-12-20/docs-2.json @@ -2,16 +2,16 @@ "version": "2.0", "service": "

You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run SQL statements, which are committed if the statement succeeds.

For more information about the Amazon Redshift Data API, see Using the Amazon Redshift Data API in the Amazon Redshift Cluster Management Guide.

", "operations": { - "BatchExecuteStatement": "

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters:

", + "BatchExecuteStatement": "

Runs one or more SQL statements, which can be data manipulation language (DML) or data definition language (DDL). Depending on the authorization method, use one of the following combinations of request parameters:

", "CancelStatement": "

Cancels a running query. To be canceled, a query must be running.

", "DescribeStatement": "

Describes the details about a specific instance when a query was run by the Amazon Redshift Data API. The information includes when the query started, when it finished, the query status, the number of rows returned, and the SQL statement.

", - "DescribeTable": "

Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters:

", - "ExecuteStatement": "

Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters:

", + "DescribeTable": "

Describes the detailed information about a table from metadata in the cluster. The information includes its columns. A token is returned to page through the column list. Depending on the authorization method, use one of the following combinations of request parameters:

", + "ExecuteStatement": "

Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters:

", "GetStatementResult": "

Fetches the temporarily cached result of an SQL statement. A token is returned to page through the statement results.

", - "ListDatabases": "

List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters:

", - "ListSchemas": "

Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters:

", + "ListDatabases": "

List the databases in a cluster. A token is returned to page through the database list. Depending on the authorization method, use one of the following combinations of request parameters:

", + "ListSchemas": "

Lists the schemas in a database. A token is returned to page through the schema list. Depending on the authorization method, use one of the following combinations of request parameters:

", "ListStatements": "

List of SQL statements. By default, only finished statements are shown. A token is returned to page through the statement list.

", - "ListTables": "

List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters:

" + "ListTables": "

List the tables in a database. If neither SchemaPattern nor TablePattern are specified, then all tables in the database are returned. A token is returned to page through the table list. Depending on the authorization method, use one of the following combinations of request parameters:

" }, "shapes": { "ActiveStatementsExceededException": { @@ -45,11 +45,11 @@ "refs": { "BatchExecuteStatementInput$WithEvent": "

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statements run.

", "CancelStatementResponse$Status": "

A value that indicates whether the cancel statement succeeded (true).

", - "DescribeStatementResponse$HasResultSet": "

A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set. The value is true if any substatement returns a result set.

", + "DescribeStatementResponse$HasResultSet": "

A value that indicates whether the statement has a result set. The result set can be empty.

", "ExecuteStatementInput$WithEvent": "

A value that indicates whether to send an event to the Amazon EventBridge event bus after the SQL statement runs.

", "ListStatementsRequest$RoleLevel": "

A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true.

", "StatementData$IsBatchStatement": "

A value that indicates whether the statement is a batch query request.

", - "SubStatementData$HasResultSet": "

A value that indicates whether the statement has a result set. The result set can be empty. The value is true for an empty result set.

" + "SubStatementData$HasResultSet": "

A value that indicates whether the statement has a result set. The result set can be empty.

" } }, "BoxedBoolean": { @@ -100,11 +100,6 @@ "GetStatementResultResponse$ColumnMetadata": "

The properties (metadata) of a column.

" } }, - "DatabaseConnectionException": { - "base": "

Connection to a database failed.

", - "refs": { - } - }, "DatabaseList": { "base": null, "refs": { @@ -231,14 +226,14 @@ "Location": { "base": null, "refs": { - "BatchExecuteStatementInput$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

", - "BatchExecuteStatementOutput$ClusterIdentifier": "

The cluster identifier. This parameter is not returned when connecting to a serverless endpoint.

", - "DescribeTableRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

", - "ExecuteStatementInput$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

", - "ExecuteStatementOutput$ClusterIdentifier": "

The cluster identifier. This parameter is not returned when connecting to a serverless endpoint.

", - "ListDatabasesRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

", - "ListSchemasRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

", - "ListTablesRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when connecting to a cluster and authenticating using either Secrets Manager or temporary credentials.

" + "BatchExecuteStatementInput$ClusterIdentifier": "

The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

", + "BatchExecuteStatementOutput$ClusterIdentifier": "

The cluster identifier.

", + "DescribeTableRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

", + "ExecuteStatementInput$ClusterIdentifier": "

The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

", + "ExecuteStatementOutput$ClusterIdentifier": "

The cluster identifier.

", + "ListDatabasesRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

", + "ListSchemasRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

", + "ListTablesRequest$ClusterIdentifier": "

The cluster identifier. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

" } }, "Long": { @@ -401,7 +396,7 @@ "BatchExecuteStatementException$Message": null, "BatchExecuteStatementException$StatementId": "

Statement identifier of the exception.

", "BatchExecuteStatementInput$Database": "

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

", - "BatchExecuteStatementInput$DbUser": "

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

", + "BatchExecuteStatementInput$DbUser": "

The database user name. This parameter is required when authenticating using temporary credentials.

", "BatchExecuteStatementOutput$Database": "

The name of the database.

", "BatchExecuteStatementOutput$DbUser": "

The database user name.

", "ColumnMetadata$columnDefault": "

The default value of the column.

", @@ -410,7 +405,6 @@ "ColumnMetadata$schemaName": "

The name of the schema that contains the table that includes the column.

", "ColumnMetadata$tableName": "

The name of the table that includes the column.

", "ColumnMetadata$typeName": "

The database-specific data type of the column.

", - "DatabaseConnectionException$Message": null, "DatabaseList$member": null, "DescribeStatementResponse$ClusterIdentifier": "

The cluster identifier.

", "DescribeStatementResponse$Database": "

The name of the database.

", @@ -418,7 +412,7 @@ "DescribeStatementResponse$Error": "

The error message from the cluster if the SQL statement encountered an error while running.

", "DescribeTableRequest$ConnectedDatabase": "

A database name. The connected database is specified when you connect with your authentication credentials.

", "DescribeTableRequest$Database": "

The name of the database that contains the tables to be described. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

", - "DescribeTableRequest$DbUser": "

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

", + "DescribeTableRequest$DbUser": "

The database user name. This parameter is required when authenticating using temporary credentials.

", "DescribeTableRequest$NextToken": "

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

", "DescribeTableRequest$Schema": "

The schema that contains the table. If no schema is specified, then matching tables for all schemas are returned.

", "DescribeTableRequest$Table": "

The table name. If no table is specified, then all tables for all matching schemas are returned. If no table and no schema is specified, then all tables for all schemas in the database are returned

", @@ -427,7 +421,7 @@ "ExecuteStatementException$Message": "

The exception message.

", "ExecuteStatementException$StatementId": "

Statement identifier of the exception.

", "ExecuteStatementInput$Database": "

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

", - "ExecuteStatementInput$DbUser": "

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

", + "ExecuteStatementInput$DbUser": "

The database user name. This parameter is required when authenticating using temporary credentials.

", "ExecuteStatementOutput$Database": "

The name of the database.

", "ExecuteStatementOutput$DbUser": "

The database user name.

", "Field$stringValue": "

A value of the string data type.

", @@ -435,12 +429,12 @@ "GetStatementResultResponse$NextToken": "

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

", "InternalServerException$Message": "

The exception message.

", "ListDatabasesRequest$Database": "

The name of the database. This parameter is required when authenticating using either Secrets Manager or temporary credentials.

", - "ListDatabasesRequest$DbUser": "

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

", + "ListDatabasesRequest$DbUser": "

The database user name. This parameter is required when authenticating using temporary credentials.

", "ListDatabasesRequest$NextToken": "

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

", "ListDatabasesResponse$NextToken": "

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

", "ListSchemasRequest$ConnectedDatabase": "

A database name. The connected database is specified when you connect with your authentication credentials.

", "ListSchemasRequest$Database": "

The name of the database that contains the schemas to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

", - "ListSchemasRequest$DbUser": "

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

", + "ListSchemasRequest$DbUser": "

The database user name. This parameter is required when authenticating using temporary credentials.

", "ListSchemasRequest$NextToken": "

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

", "ListSchemasRequest$SchemaPattern": "

A pattern to filter results by schema name. Within a schema pattern, \"%\" means match any substring of 0 or more characters and \"_\" means match any one character. Only schema name entries matching the search pattern are returned.

", "ListSchemasResponse$NextToken": "

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

", @@ -448,7 +442,7 @@ "ListStatementsResponse$NextToken": "

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

", "ListTablesRequest$ConnectedDatabase": "

A database name. The connected database is specified when you connect with your authentication credentials.

", "ListTablesRequest$Database": "

The name of the database that contains the tables to list. If ConnectedDatabase is not specified, this is also the database to connect to with your authentication credentials.

", - "ListTablesRequest$DbUser": "

The database user name. This parameter is required when connecting to a cluster and authenticating using temporary credentials.

", + "ListTablesRequest$DbUser": "

The database user name. This parameter is required when authenticating using temporary credentials.

", "ListTablesRequest$NextToken": "

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request.

", "ListTablesRequest$SchemaPattern": "

A pattern to filter results by schema name. Within a schema pattern, \"%\" means match any substring of 0 or more characters and \"_\" means match any one character. Only schema name entries matching the search pattern are returned. If SchemaPattern is not specified, then all tables that match TablePattern are returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.

", "ListTablesRequest$TablePattern": "

A pattern to filter results by table name. Within a table pattern, \"%\" means match any substring of 0 or more characters and \"_\" means match any one character. Only table name entries matching the search pattern are returned. If TablePattern is not specified, then all tables that match SchemaPatternare returned. If neither SchemaPattern or TablePattern are specified, then all tables are returned.

", diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index a8dad5d0a4..927dc3f66c 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -3258,6 +3258,19 @@ } } }, + "drs" : { + "endpoints" : { + "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "eu-central-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, "ds" : { "endpoints" : { "af-south-1" : { }, @@ -7409,6 +7422,7 @@ }, "mgn" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -7419,8 +7433,11 @@ "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, + "eu-west-3" : { }, + "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, diff --git a/service/appconfig/api.go b/service/appconfig/api.go index c2c13d0085..21ce9d6ca4 100644 --- a/service/appconfig/api.go +++ b/service/appconfig/api.go @@ -57,11 +57,11 @@ func (c *AppConfig) CreateApplicationRequest(input *CreateApplicationInput) (req // CreateApplication API operation for Amazon AppConfig. // -// An application in AppConfig is a logical unit of code that provides capabilities -// for your customers. For example, an application can be a microservice that -// runs on Amazon EC2 instances, a mobile application installed by your users, -// a serverless application using Amazon API Gateway and AWS Lambda, or any -// system you run on behalf of others. +// Creates an application. An application in AppConfig is a logical unit of +// code that provides capabilities for your customers. For example, an application +// can be a microservice that runs on Amazon EC2 instances, a mobile application +// installed by your users, a serverless application using Amazon API Gateway +// and Lambda, or any system you run on behalf of others. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -72,7 +72,8 @@ func (c *AppConfig) CreateApplicationRequest(input *CreateApplicationInput) (req // // Returned Error Types: // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // * InternalServerException // There was an internal failure in the AppConfig service. @@ -143,22 +144,25 @@ func (c *AppConfig) CreateConfigurationProfileRequest(input *CreateConfiguration // CreateConfigurationProfile API operation for Amazon AppConfig. // -// Information that enables AppConfig to access the configuration source. Valid -// configuration sources include Systems Manager (SSM) documents, SSM Parameter -// Store parameters, and Amazon S3 objects. A configuration profile includes -// the following information. +// Creates a configuration profile, which is information that enables AppConfig +// to access the configuration source. Valid configuration sources include the +// AppConfig hosted configuration store, Amazon Web Services Systems Manager +// (SSM) documents, SSM Parameter Store parameters, Amazon S3 objects, or any +// integration source action (http://docs.aws.amazon.com/codepipeline/latest/userguide/integrations-action-type.html#integrations-source) +// supported by CodePipeline. A configuration profile includes the following +// information: // -// * The Uri location of the configuration data. +// * The URI location of the configuration data. // -// * The AWS Identity and Access Management (IAM) role that provides access -// to the configuration data. +// * The Identity and Access Management (IAM) role that provides access to +// the configuration data. // // * A validator for the configuration data. Available validators include -// either a JSON Schema or an AWS Lambda function. +// either a JSON Schema or an Lambda function. // // For more information, see Create a Configuration and a Configuration Profile -// (http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig-creating-configuration-and-profile.html) -// in the AWS AppConfig User Guide. +// (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html) +// in the AppConfig User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -169,7 +173,8 @@ func (c *AppConfig) CreateConfigurationProfileRequest(input *CreateConfiguration // // Returned Error Types: // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // * ResourceNotFoundException // The requested resource could not be found. @@ -243,10 +248,11 @@ func (c *AppConfig) CreateDeploymentStrategyRequest(input *CreateDeploymentStrat // CreateDeploymentStrategy API operation for Amazon AppConfig. // -// A deployment strategy defines important criteria for rolling out your configuration -// to the designated targets. A deployment strategy includes: the overall duration -// required, a percentage of targets to receive the deployment during each interval, -// an algorithm that defines how percentage grows, and bake time. +// Creates a deployment strategy that defines important criteria for rolling +// out your configuration to the designated targets. A deployment strategy includes +// the overall duration required, a percentage of targets to receive the deployment +// during each interval, an algorithm that defines how percentage grows, and +// bake time. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -260,7 +266,8 @@ func (c *AppConfig) CreateDeploymentStrategyRequest(input *CreateDeploymentStrat // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateDeploymentStrategy func (c *AppConfig) CreateDeploymentStrategy(input *CreateDeploymentStrategyInput) (*CreateDeploymentStrategyOutput, error) { @@ -328,10 +335,10 @@ func (c *AppConfig) CreateEnvironmentRequest(input *CreateEnvironmentInput) (req // CreateEnvironment API operation for Amazon AppConfig. // -// For each application, you define one or more environments. An environment -// is a logical deployment group of AppConfig targets, such as applications -// in a Beta or Production environment. You can also define environments for -// application subcomponents such as the Web, Mobile and Back-end components +// Creates an environment. For each application, you define one or more environments. +// An environment is a logical deployment group of AppConfig targets, such as +// applications in a Beta or Production environment. You can also define environments +// for application subcomponents such as the Web, Mobile and Back-end components // for your application. You can configure Amazon CloudWatch alarms for each // environment. The system monitors alarms during a configuration deployment. // If an alarm is triggered, the system rolls back the configuration. @@ -351,7 +358,8 @@ func (c *AppConfig) CreateEnvironmentRequest(input *CreateEnvironmentInput) (req // The requested resource could not be found. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/CreateEnvironment func (c *AppConfig) CreateEnvironment(input *CreateEnvironmentInput) (*CreateEnvironmentOutput, error) { @@ -419,7 +427,7 @@ func (c *AppConfig) CreateHostedConfigurationVersionRequest(input *CreateHostedC // CreateHostedConfigurationVersion API operation for Amazon AppConfig. // -// Create a new configuration in the AppConfig configuration store. +// Creates a new configuration in the AppConfig hosted configuration store. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -430,11 +438,12 @@ func (c *AppConfig) CreateHostedConfigurationVersionRequest(input *CreateHostedC // // Returned Error Types: // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // * ServiceQuotaExceededException // The number of hosted configuration versions exceeds the limit for the AppConfig -// configuration store. Delete one or more versions and try again. +// hosted configuration store. Delete one or more versions and try again. // // * ResourceNotFoundException // The requested resource could not be found. @@ -516,7 +525,7 @@ func (c *AppConfig) DeleteApplicationRequest(input *DeleteApplicationInput) (req // DeleteApplication API operation for Amazon AppConfig. // -// Delete an application. Deleting an application does not delete a configuration +// Deletes an application. Deleting an application does not delete a configuration // from a host. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -534,7 +543,8 @@ func (c *AppConfig) DeleteApplicationRequest(input *DeleteApplicationInput) (req // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteApplication func (c *AppConfig) DeleteApplication(input *DeleteApplicationInput) (*DeleteApplicationOutput, error) { @@ -603,7 +613,7 @@ func (c *AppConfig) DeleteConfigurationProfileRequest(input *DeleteConfiguration // DeleteConfigurationProfile API operation for Amazon AppConfig. // -// Delete a configuration profile. Deleting a configuration profile does not +// Deletes a configuration profile. Deleting a configuration profile does not // delete a configuration from a host. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -625,7 +635,8 @@ func (c *AppConfig) DeleteConfigurationProfileRequest(input *DeleteConfiguration // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteConfigurationProfile func (c *AppConfig) DeleteConfigurationProfile(input *DeleteConfigurationProfileInput) (*DeleteConfigurationProfileOutput, error) { @@ -694,7 +705,7 @@ func (c *AppConfig) DeleteDeploymentStrategyRequest(input *DeleteDeploymentStrat // DeleteDeploymentStrategy API operation for Amazon AppConfig. // -// Delete a deployment strategy. Deleting a deployment strategy does not delete +// Deletes a deployment strategy. Deleting a deployment strategy does not delete // a configuration from a host. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -712,7 +723,8 @@ func (c *AppConfig) DeleteDeploymentStrategyRequest(input *DeleteDeploymentStrat // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteDeploymentStrategy func (c *AppConfig) DeleteDeploymentStrategy(input *DeleteDeploymentStrategyInput) (*DeleteDeploymentStrategyOutput, error) { @@ -781,7 +793,7 @@ func (c *AppConfig) DeleteEnvironmentRequest(input *DeleteEnvironmentInput) (req // DeleteEnvironment API operation for Amazon AppConfig. // -// Delete an environment. Deleting an environment does not delete a configuration +// Deletes an environment. Deleting an environment does not delete a configuration // from a host. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -803,7 +815,8 @@ func (c *AppConfig) DeleteEnvironmentRequest(input *DeleteEnvironmentInput) (req // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/DeleteEnvironment func (c *AppConfig) DeleteEnvironment(input *DeleteEnvironmentInput) (*DeleteEnvironmentOutput, error) { @@ -872,7 +885,8 @@ func (c *AppConfig) DeleteHostedConfigurationVersionRequest(input *DeleteHostedC // DeleteHostedConfigurationVersion API operation for Amazon AppConfig. // -// Delete a version of a configuration from the AppConfig configuration store. +// Deletes a version of a configuration from the AppConfig hosted configuration +// store. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -883,7 +897,8 @@ func (c *AppConfig) DeleteHostedConfigurationVersionRequest(input *DeleteHostedC // // Returned Error Types: // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // * ResourceNotFoundException // The requested resource could not be found. @@ -957,7 +972,7 @@ func (c *AppConfig) GetApplicationRequest(input *GetApplicationInput) (req *requ // GetApplication API operation for Amazon AppConfig. // -// Retrieve information about an application. +// Retrieves information about an application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -974,7 +989,8 @@ func (c *AppConfig) GetApplicationRequest(input *GetApplicationInput) (req *requ // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetApplication func (c *AppConfig) GetApplication(input *GetApplicationInput) (*GetApplicationOutput, error) { @@ -1042,13 +1058,12 @@ func (c *AppConfig) GetConfigurationRequest(input *GetConfigurationInput) (req * // GetConfiguration API operation for Amazon AppConfig. // -// Receive information about a configuration. +// Retrieves information about a configuration. // -// AWS AppConfig uses the value of the ClientConfigurationVersion parameter -// to identify the configuration version on your clients. If you don’t send -// ClientConfigurationVersion with each call to GetConfiguration, your clients -// receive the current configuration. You are charged each time your clients -// receive a configuration. +// AppConfig uses the value of the ClientConfigurationVersion parameter to identify +// the configuration version on your clients. If you don’t send ClientConfigurationVersion +// with each call to GetConfiguration, your clients receive the current configuration. +// You are charged each time your clients receive a configuration. // // To avoid excess charges, we recommend that you include the ClientConfigurationVersion // value with every call to GetConfiguration. This value must be saved on your @@ -1070,7 +1085,8 @@ func (c *AppConfig) GetConfigurationRequest(input *GetConfigurationInput) (req * // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetConfiguration func (c *AppConfig) GetConfiguration(input *GetConfigurationInput) (*GetConfigurationOutput, error) { @@ -1138,7 +1154,7 @@ func (c *AppConfig) GetConfigurationProfileRequest(input *GetConfigurationProfil // GetConfigurationProfile API operation for Amazon AppConfig. // -// Retrieve information about a configuration profile. +// Retrieves information about a configuration profile. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1155,7 +1171,8 @@ func (c *AppConfig) GetConfigurationProfileRequest(input *GetConfigurationProfil // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetConfigurationProfile func (c *AppConfig) GetConfigurationProfile(input *GetConfigurationProfileInput) (*GetConfigurationProfileOutput, error) { @@ -1223,7 +1240,7 @@ func (c *AppConfig) GetDeploymentRequest(input *GetDeploymentInput) (req *reques // GetDeployment API operation for Amazon AppConfig. // -// Retrieve information about a configuration deployment. +// Retrieves information about a configuration deployment. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1240,7 +1257,8 @@ func (c *AppConfig) GetDeploymentRequest(input *GetDeploymentInput) (req *reques // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetDeployment func (c *AppConfig) GetDeployment(input *GetDeploymentInput) (*GetDeploymentOutput, error) { @@ -1308,11 +1326,11 @@ func (c *AppConfig) GetDeploymentStrategyRequest(input *GetDeploymentStrategyInp // GetDeploymentStrategy API operation for Amazon AppConfig. // -// Retrieve information about a deployment strategy. A deployment strategy defines -// important criteria for rolling out your configuration to the designated targets. -// A deployment strategy includes: the overall duration required, a percentage -// of targets to receive the deployment during each interval, an algorithm that -// defines how percentage grows, and bake time. +// Retrieves information about a deployment strategy. A deployment strategy +// defines important criteria for rolling out your configuration to the designated +// targets. A deployment strategy includes the overall duration required, a +// percentage of targets to receive the deployment during each interval, an +// algorithm that defines how percentage grows, and bake time. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1329,7 +1347,8 @@ func (c *AppConfig) GetDeploymentStrategyRequest(input *GetDeploymentStrategyInp // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetDeploymentStrategy func (c *AppConfig) GetDeploymentStrategy(input *GetDeploymentStrategyInput) (*GetDeploymentStrategyOutput, error) { @@ -1397,7 +1416,7 @@ func (c *AppConfig) GetEnvironmentRequest(input *GetEnvironmentInput) (req *requ // GetEnvironment API operation for Amazon AppConfig. // -// Retrieve information about an environment. An environment is a logical deployment +// Retrieves information about an environment. An environment is a logical deployment // group of AppConfig applications, such as applications in a Production environment // or in an EU_Region environment. Each configuration deployment targets an // environment. You can enable one or more Amazon CloudWatch alarms for an environment. @@ -1418,7 +1437,8 @@ func (c *AppConfig) GetEnvironmentRequest(input *GetEnvironmentInput) (req *requ // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/GetEnvironment func (c *AppConfig) GetEnvironment(input *GetEnvironmentInput) (*GetEnvironmentOutput, error) { @@ -1486,7 +1506,7 @@ func (c *AppConfig) GetHostedConfigurationVersionRequest(input *GetHostedConfigu // GetHostedConfigurationVersion API operation for Amazon AppConfig. // -// Get information about a specific configuration version. +// Retrieves information about a specific configuration version. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1497,7 +1517,8 @@ func (c *AppConfig) GetHostedConfigurationVersionRequest(input *GetHostedConfigu // // Returned Error Types: // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // * ResourceNotFoundException // The requested resource could not be found. @@ -1577,7 +1598,7 @@ func (c *AppConfig) ListApplicationsRequest(input *ListApplicationsInput) (req * // ListApplications API operation for Amazon AppConfig. // -// List all applications in your AWS account. +// Lists all applications in your Amazon Web Services account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1591,7 +1612,8 @@ func (c *AppConfig) ListApplicationsRequest(input *ListApplicationsInput) (req * // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListApplications func (c *AppConfig) ListApplications(input *ListApplicationsInput) (*ListApplicationsOutput, error) { @@ -1734,7 +1756,8 @@ func (c *AppConfig) ListConfigurationProfilesRequest(input *ListConfigurationPro // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListConfigurationProfiles func (c *AppConfig) ListConfigurationProfiles(input *ListConfigurationProfilesInput) (*ListConfigurationProfilesOutput, error) { @@ -1860,7 +1883,7 @@ func (c *AppConfig) ListDeploymentStrategiesRequest(input *ListDeploymentStrateg // ListDeploymentStrategies API operation for Amazon AppConfig. // -// List deployment strategies. +// Lists deployment strategies. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1874,7 +1897,8 @@ func (c *AppConfig) ListDeploymentStrategiesRequest(input *ListDeploymentStrateg // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListDeploymentStrategies func (c *AppConfig) ListDeploymentStrategies(input *ListDeploymentStrategiesInput) (*ListDeploymentStrategiesOutput, error) { @@ -2017,7 +2041,8 @@ func (c *AppConfig) ListDeploymentsRequest(input *ListDeploymentsInput) (req *re // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListDeployments func (c *AppConfig) ListDeployments(input *ListDeploymentsInput) (*ListDeploymentsOutput, error) { @@ -2143,7 +2168,7 @@ func (c *AppConfig) ListEnvironmentsRequest(input *ListEnvironmentsInput) (req * // ListEnvironments API operation for Amazon AppConfig. // -// List the environments for an application. +// Lists the environments for an application. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2160,7 +2185,8 @@ func (c *AppConfig) ListEnvironmentsRequest(input *ListEnvironmentsInput) (req * // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/ListEnvironments func (c *AppConfig) ListEnvironments(input *ListEnvironmentsInput) (*ListEnvironmentsOutput, error) { @@ -2286,8 +2312,8 @@ func (c *AppConfig) ListHostedConfigurationVersionsRequest(input *ListHostedConf // ListHostedConfigurationVersions API operation for Amazon AppConfig. // -// View a list of configurations stored in the AppConfig configuration store -// by version. +// Lists configurations stored in the AppConfig hosted configuration store by +// version. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2298,7 +2324,8 @@ func (c *AppConfig) ListHostedConfigurationVersionsRequest(input *ListHostedConf // // Returned Error Types: // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // * ResourceNotFoundException // The requested resource could not be found. @@ -2438,7 +2465,8 @@ func (c *AppConfig) ListTagsForResourceRequest(input *ListTagsForResourceInput) // The requested resource could not be found. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // * InternalServerException // There was an internal failure in the AppConfig service. @@ -2520,7 +2548,8 @@ func (c *AppConfig) StartDeploymentRequest(input *StartDeploymentInput) (req *re // // Returned Error Types: // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // * ResourceNotFoundException // The requested resource could not be found. @@ -2616,7 +2645,8 @@ func (c *AppConfig) StopDeploymentRequest(input *StopDeploymentInput) (req *requ // There was an internal failure in the AppConfig service. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // See also, https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09/StopDeployment func (c *AppConfig) StopDeployment(input *StopDeploymentInput) (*StopDeploymentOutput, error) { @@ -2685,7 +2715,7 @@ func (c *AppConfig) TagResourceRequest(input *TagResourceInput) (req *request.Re // TagResource API operation for Amazon AppConfig. // -// Metadata to assign to an AppConfig resource. Tags help organize and categorize +// Assigns metadata to an AppConfig resource. Tags help organize and categorize // your AppConfig resources. Each tag consists of a key and an optional value, // both of which you define. You can specify a maximum of 50 tags for a resource. // @@ -2701,7 +2731,8 @@ func (c *AppConfig) TagResourceRequest(input *TagResourceInput) (req *request.Re // The requested resource could not be found. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // * InternalServerException // There was an internal failure in the AppConfig service. @@ -2787,7 +2818,8 @@ func (c *AppConfig) UntagResourceRequest(input *UntagResourceInput) (req *reques // The requested resource could not be found. // // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // * InternalServerException // There was an internal failure in the AppConfig service. @@ -2869,7 +2901,8 @@ func (c *AppConfig) UpdateApplicationRequest(input *UpdateApplicationInput) (req // // Returned Error Types: // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // * ResourceNotFoundException // The requested resource could not be found. @@ -2954,7 +2987,8 @@ func (c *AppConfig) UpdateConfigurationProfileRequest(input *UpdateConfiguration // // Returned Error Types: // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // * ResourceNotFoundException // The requested resource could not be found. @@ -3039,7 +3073,8 @@ func (c *AppConfig) UpdateDeploymentStrategyRequest(input *UpdateDeploymentStrat // // Returned Error Types: // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // * ResourceNotFoundException // The requested resource could not be found. @@ -3124,7 +3159,8 @@ func (c *AppConfig) UpdateEnvironmentRequest(input *UpdateEnvironmentInput) (req // // Returned Error Types: // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // * ResourceNotFoundException // The requested resource could not be found. @@ -3210,7 +3246,8 @@ func (c *AppConfig) ValidateConfigurationRequest(input *ValidateConfigurationInp // // Returned Error Types: // * BadRequestException -// The input fails to satisfy the constraints specified by an AWS service. +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. // // * ResourceNotFoundException // The requested resource could not be found. @@ -3289,12 +3326,53 @@ func (s *Application) SetName(v string) *Application { return s } -// The input fails to satisfy the constraints specified by an AWS service. +// Detailed information about the input that failed to satisfy the constraints +// specified by an AWS service. +type BadRequestDetails struct { + _ struct{} `type:"structure"` + + // Detailed information about the bad request exception error when creating + // a hosted configuration version. + InvalidConfiguration []*InvalidConfigurationDetail `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BadRequestDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s BadRequestDetails) GoString() string { + return s.String() +} + +// SetInvalidConfiguration sets the InvalidConfiguration field's value. +func (s *BadRequestDetails) SetInvalidConfiguration(v []*InvalidConfigurationDetail) *BadRequestDetails { + s.InvalidConfiguration = v + return s +} + +// The input fails to satisfy the constraints specified by an Amazon Web Services +// service. type BadRequestException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + // Detailed information about the input that failed to satisfy the constraints + // specified by an AWS service. + Details *BadRequestDetails `type:"structure"` + Message_ *string `locationName:"Message" type:"string"` + + Reason *string `type:"string" enum:"BadRequestReason"` } // String returns the string representation. @@ -3340,7 +3418,7 @@ func (s *BadRequestException) OrigErr() error { } func (s *BadRequestException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) } // Status code returns the HTTP status code for the request's response error. @@ -3369,6 +3447,11 @@ type ConfigurationProfileSummary struct { // The name of the configuration profile. Name *string `min:"1" type:"string"` + // The type of configurations that the configuration profile contains. A configuration + // can be a feature flag used for enabling or disabling new features or a free-form + // configuration used to introduce changes to your application. + Type *string `type:"string"` + // The types of validators in the configuration profile. ValidatorTypes []*string `type:"list"` } @@ -3415,6 +3498,12 @@ func (s *ConfigurationProfileSummary) SetName(v string) *ConfigurationProfileSum return s } +// SetType sets the Type field's value. +func (s *ConfigurationProfileSummary) SetType(v string) *ConfigurationProfileSummary { + s.Type = &v + return s +} + // SetValidatorTypes sets the ValidatorTypes field's value. func (s *ConfigurationProfileSummary) SetValidatorTypes(v []*string) *ConfigurationProfileSummary { s.ValidatorTypes = v @@ -3615,13 +3704,14 @@ type CreateConfigurationProfileInput struct { // A description of the configuration profile. Description *string `type:"string"` - // A URI to locate the configuration. You can specify a Systems Manager (SSM) - // document, an SSM Parameter Store parameter, or an Amazon S3 object. For an - // SSM document, specify either the document name in the format ssm-document:// - // or the Amazon Resource Name (ARN). For a parameter, specify either the parameter - // name in the format ssm-parameter:// or the ARN. For an Amazon - // S3 object, specify the URI in the following format: s3:/// - // . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json + // A URI to locate the configuration. You can specify the AppConfig hosted configuration + // store, Systems Manager (SSM) document, an SSM Parameter Store parameter, + // or an Amazon S3 object. For the hosted configuration store and for feature + // flags, specify hosted. For an SSM document, specify either the document name + // in the format ssm-document:// or the Amazon Resource Name + // (ARN). For a parameter, specify either the parameter name in the format ssm-parameter:// + // or the ARN. For an Amazon S3 object, specify the URI in the following format: + // s3:/// . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json // // LocationUri is a required field LocationUri *string `min:"1" type:"string" required:"true"` @@ -3633,6 +3723,10 @@ type CreateConfigurationProfileInput struct { // The ARN of an IAM role with permission to access the configuration at the // specified LocationUri. + // + // A retrieval role ARN is not required for configurations stored in the AppConfig + // hosted configuration store. It is required for all other sources that store + // your configuration. RetrievalRoleArn *string `min:"20" type:"string"` // Metadata to assign to the configuration profile. Tags help organize and categorize @@ -3640,6 +3734,11 @@ type CreateConfigurationProfileInput struct { // both of which you define. Tags map[string]*string `type:"map"` + // The type of configurations that the configuration profile contains. A configuration + // can be a feature flag used for enabling or disabling new features or a free-form + // configuration used for distributing configurations to your application. + Type *string `type:"string"` + // A list of methods for validating the configuration. Validators []*Validator `type:"list"` } @@ -3739,6 +3838,12 @@ func (s *CreateConfigurationProfileInput) SetTags(v map[string]*string) *CreateC return s } +// SetType sets the Type field's value. +func (s *CreateConfigurationProfileInput) SetType(v string) *CreateConfigurationProfileInput { + s.Type = &v + return s +} + // SetValidators sets the Validators field's value. func (s *CreateConfigurationProfileInput) SetValidators(v []*Validator) *CreateConfigurationProfileInput { s.Validators = v @@ -3767,6 +3872,11 @@ type CreateConfigurationProfileOutput struct { // specified LocationUri. RetrievalRoleArn *string `min:"20" type:"string"` + // The type of configurations that the configuration profile contains. A configuration + // can be a feature flag used for enabling or disabling new features or a free-form + // configuration used for distributing configurations to your application. + Type *string `type:"string"` + // A list of methods for validating the configuration. Validators []*Validator `type:"list"` } @@ -3825,6 +3935,12 @@ func (s *CreateConfigurationProfileOutput) SetRetrievalRoleArn(v string) *Create return s } +// SetType sets the Type field's value. +func (s *CreateConfigurationProfileOutput) SetType(v string) *CreateConfigurationProfileOutput { + s.Type = &v + return s +} + // SetValidators sets the Validators field's value. func (s *CreateConfigurationProfileOutput) SetValidators(v []*Validator) *CreateConfigurationProfileOutput { s.Validators = v @@ -3852,8 +3968,8 @@ type CreateDeploymentStrategyInput struct { // GrowthFactor is a required field GrowthFactor *float64 `min:"1" type:"float" required:"true"` - // The algorithm used to define how percentage grows over time. AWS AppConfig - // supports the following growth types: + // The algorithm used to define how percentage grows over time. AppConfig supports + // the following growth types: // // Linear: For this type, AppConfig processes the deployment by dividing the // total number of targets by the value specified for Step percentage. For example, @@ -3998,8 +4114,8 @@ type CreateDeploymentStrategyOutput struct { // The description of the deployment strategy. Description *string `type:"string"` - // The amount of time AppConfig monitored for alarms before considering the - // deployment to be complete and no longer eligible for automatic roll back. + // The amount of time that AppConfig monitored for alarms before considering + // the deployment to be complete and no longer eligible for automatic rollback. FinalBakeTimeInMinutes *int64 `type:"integer"` // The percentage of targets that received a deployed configuration during each @@ -4290,7 +4406,7 @@ type CreateHostedConfigurationVersionInput struct { Content []byte `type:"blob" required:"true" sensitive:"true"` // A standard MIME type describing the format of the configuration content. - // For more information, see Content-Type (https://docs.aws.amazon.com/https:/www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). + // For more information, see Content-Type (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). // // ContentType is a required field ContentType *string `location:"header" locationName:"Content-Type" min:"1" type:"string" required:"true"` @@ -4301,7 +4417,8 @@ type CreateHostedConfigurationVersionInput struct { // An optional locking token used to prevent race conditions from overwriting // configuration updates when creating a new version. To ensure your data is // not overwritten when creating multiple hosted configuration versions in rapid - // succession, specify the version of the latest hosted configuration version. + // succession, specify the version number of the latest hosted configuration + // version. LatestVersionNumber *int64 `location:"header" locationName:"Latest-Version-Number" type:"integer"` } @@ -4407,7 +4524,7 @@ type CreateHostedConfigurationVersionOutput struct { Content []byte `type:"blob" sensitive:"true"` // A standard MIME type describing the format of the configuration content. - // For more information, see Content-Type (https://docs.aws.amazon.com/https:/www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). + // For more information, see Content-Type (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). ContentType *string `location:"header" locationName:"Content-Type" min:"1" type:"string"` // A description of the configuration. @@ -4704,12 +4821,12 @@ func (s DeleteDeploymentStrategyOutput) GoString() string { type DeleteEnvironmentInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The application ID that includes the environment you want to delete. + // The application ID that includes the environment that you want to delete. // // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"ApplicationId" type:"string" required:"true"` - // The ID of the environment you want to delete. + // The ID of the environment that you want to delete. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"EnvironmentId" type:"string" required:"true"` @@ -4896,21 +5013,21 @@ type DeploymentEvent struct { _ struct{} `type:"structure"` // A description of the deployment event. Descriptions include, but are not - // limited to, the user account or the CloudWatch alarm ARN that initiated a - // rollback, the percentage of hosts that received the deployment, or in the + // limited to, the user account or the Amazon CloudWatch alarm ARN that initiated + // a rollback, the percentage of hosts that received the deployment, or in the // case of an internal error, a recommendation to attempt a new deployment. Description *string `type:"string"` // The type of deployment event. Deployment event types include the start, stop, // or completion of a deployment; a percentage update; the start or stop of - // a bake period; the start or completion of a rollback. + // a bake period; and the start or completion of a rollback. EventType *string `type:"string" enum:"DeploymentEventType"` // The date and time the event occurred. OccurredAt *time.Time `type:"timestamp" timestampFormat:"iso8601"` // The entity that triggered the deployment event. Events can be triggered by - // a user, AWS AppConfig, an Amazon CloudWatch alarm, or an internal error. + // a user, AppConfig, an Amazon CloudWatch alarm, or an internal error. TriggeredBy *string `type:"string" enum:"TriggeredBy"` } @@ -4965,8 +5082,8 @@ type DeploymentStrategy struct { // The description of the deployment strategy. Description *string `type:"string"` - // The amount of time AppConfig monitored for alarms before considering the - // deployment to be complete and no longer eligible for automatic roll back. + // The amount of time that AppConfig monitored for alarms before considering + // the deployment to be complete and no longer eligible for automatic rollback. FinalBakeTimeInMinutes *int64 `type:"integer"` // The percentage of targets that received a deployed configuration during each @@ -5071,8 +5188,8 @@ type DeploymentSummary struct { // The sequence number of the deployment. DeploymentNumber *int64 `type:"integer"` - // The amount of time AppConfig monitors for alarms before considering the deployment - // to be complete and no longer eligible for automatic roll back. + // The amount of time that AppConfig monitors for alarms before considering + // the deployment to be complete and no longer eligible for automatic rollback. FinalBakeTimeInMinutes *int64 `type:"integer"` // The percentage of targets to receive a deployed configuration during each @@ -5362,11 +5479,10 @@ type GetConfigurationInput struct { // The configuration version returned in the most recent GetConfiguration response. // - // AWS AppConfig uses the value of the ClientConfigurationVersion parameter - // to identify the configuration version on your clients. If you don’t send - // ClientConfigurationVersion with each call to GetConfiguration, your clients - // receive the current configuration. You are charged each time your clients - // receive a configuration. + // AppConfig uses the value of the ClientConfigurationVersion parameter to identify + // the configuration version on your clients. If you don’t send ClientConfigurationVersion + // with each call to GetConfiguration, your clients receive the current configuration. + // You are charged each time your clients receive a configuration. // // To avoid excess charges, we recommend that you include the ClientConfigurationVersion // value with every call to GetConfiguration. This value must be saved on your @@ -5374,13 +5490,13 @@ type GetConfigurationInput struct { // the ClientConfigurationVersion parameter. // // For more information about working with configurations, see Retrieving the - // Configuration (https://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig-retrieving-the-configuration.html) - // in the AWS AppConfig User Guide. + // Configuration (http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-retrieving-the-configuration.html) + // in the AppConfig User Guide. ClientConfigurationVersion *string `location:"querystring" locationName:"client_configuration_version" min:"1" type:"string"` - // A unique ID to identify the client for the configuration. This ID enables - // AppConfig to deploy the configuration in intervals, as defined in the deployment - // strategy. + // The clientId parameter in the following command is a unique, user-specified + // ID to identify the client for the configuration. This ID enables AppConfig + // to deploy the configuration in intervals, as defined in the deployment strategy. // // ClientId is a required field ClientId *string `location:"querystring" locationName:"client_id" min:"1" type:"string" required:"true"` @@ -5491,6 +5607,13 @@ type GetConfigurationOutput struct { // The content of the configuration or the configuration data. // + // Compare the configuration version numbers of the configuration cached locally + // on your machine and the configuration number in the the header. If the configuration + // numbers are the same, the content can be ignored. The Content section only + // appears if the system finds new or updated configuration data. If the system + // doesn't find new or updated configuration data, then the Content section + // is not returned. + // // Content is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by GetConfigurationOutput's // String and GoString methods. @@ -5546,7 +5669,7 @@ type GetConfigurationProfileInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"ApplicationId" type:"string" required:"true"` - // The ID of the configuration profile you want to get. + // The ID of the configuration profile that you want to get. // // ConfigurationProfileId is a required field ConfigurationProfileId *string `location:"uri" locationName:"ConfigurationProfileId" type:"string" required:"true"` @@ -5626,6 +5749,11 @@ type GetConfigurationProfileOutput struct { // specified LocationUri. RetrievalRoleArn *string `min:"20" type:"string"` + // The type of configurations that the configuration profile contains. A configuration + // can be a feature flag used for enabling or disabling new features or a free-form + // configuration used for distributing configurations to your application. + Type *string `type:"string"` + // A list of methods for validating the configuration. Validators []*Validator `type:"list"` } @@ -5684,6 +5812,12 @@ func (s *GetConfigurationProfileOutput) SetRetrievalRoleArn(v string) *GetConfig return s } +// SetType sets the Type field's value. +func (s *GetConfigurationProfileOutput) SetType(v string) *GetConfigurationProfileOutput { + s.Type = &v + return s +} + // SetValidators sets the Validators field's value. func (s *GetConfigurationProfileOutput) SetValidators(v []*Validator) *GetConfigurationProfileOutput { s.Validators = v @@ -5810,8 +5944,8 @@ type GetDeploymentOutput struct { // are displayed first. EventLog []*DeploymentEvent `type:"list"` - // The amount of time AppConfig monitored for alarms before considering the - // deployment to be complete and no longer eligible for automatic roll back. + // The amount of time that AppConfig monitored for alarms before considering + // the deployment to be complete and no longer eligible for automatic rollback. FinalBakeTimeInMinutes *int64 `type:"integer"` // The percentage of targets to receive a deployed configuration during each @@ -6015,8 +6149,8 @@ type GetDeploymentStrategyOutput struct { // The description of the deployment strategy. Description *string `type:"string"` - // The amount of time AppConfig monitored for alarms before considering the - // deployment to be complete and no longer eligible for automatic roll back. + // The amount of time that AppConfig monitored for alarms before considering + // the deployment to be complete and no longer eligible for automatic rollback. FinalBakeTimeInMinutes *int64 `type:"integer"` // The percentage of targets that received a deployed configuration during each @@ -6110,7 +6244,7 @@ type GetEnvironmentInput struct { // ApplicationId is a required field ApplicationId *string `location:"uri" locationName:"ApplicationId" type:"string" required:"true"` - // The ID of the environment you wnat to get. + // The ID of the environment that you want to get. // // EnvironmentId is a required field EnvironmentId *string `location:"uri" locationName:"EnvironmentId" type:"string" required:"true"` @@ -6342,7 +6476,7 @@ type GetHostedConfigurationVersionOutput struct { Content []byte `type:"blob" sensitive:"true"` // A standard MIME type describing the format of the configuration content. - // For more information, see Content-Type (https://docs.aws.amazon.com/https:/www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). + // For more information, see Content-Type (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). ContentType *string `location:"header" locationName:"Content-Type" min:"1" type:"string"` // A description of the configuration. @@ -6417,7 +6551,7 @@ type HostedConfigurationVersionSummary struct { ConfigurationProfileId *string `type:"string"` // A standard MIME type describing the format of the configuration content. - // For more information, see Content-Type (https://docs.aws.amazon.com/https:/www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). + // For more information, see Content-Type (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17). ContentType *string `min:"1" type:"string"` // A description of the configuration. @@ -6539,6 +6673,68 @@ func (s *InternalServerException) RequestID() string { return s.RespMetadata.RequestID } +// Detailed information about the bad request exception error when creating +// a hosted configuration version. +type InvalidConfigurationDetail struct { + _ struct{} `type:"structure"` + + // The invalid or out-of-range validation constraint in your JSON schema that + // failed validation. + Constraint *string `type:"string"` + + // Location of the validation constraint in the configuration JSON schema that + // failed validation. + Location *string `type:"string"` + + // The reason for an invalid configuration error. + Reason *string `type:"string"` + + // The type of error for an invalid configuration. + Type *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InvalidConfigurationDetail) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InvalidConfigurationDetail) GoString() string { + return s.String() +} + +// SetConstraint sets the Constraint field's value. +func (s *InvalidConfigurationDetail) SetConstraint(v string) *InvalidConfigurationDetail { + s.Constraint = &v + return s +} + +// SetLocation sets the Location field's value. +func (s *InvalidConfigurationDetail) SetLocation(v string) *InvalidConfigurationDetail { + s.Location = &v + return s +} + +// SetReason sets the Reason field's value. +func (s *InvalidConfigurationDetail) SetReason(v string) *InvalidConfigurationDetail { + s.Reason = &v + return s +} + +// SetType sets the Type field's value. +func (s *InvalidConfigurationDetail) SetType(v string) *InvalidConfigurationDetail { + s.Type = &v + return s +} + type ListApplicationsInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -6547,7 +6743,11 @@ type ListApplicationsInput struct { // results. MaxResults *int64 `location:"querystring" locationName:"max_results" min:"1" type:"integer"` - // A token to start the list. Use this token to get the next set of results. + // A token to start the list. Next token is a pagination token generated by + // AppConfig to describe what page the previous List call ended on. For the + // first List request, the nextToken should not be set. On subsequent calls, + // the nextToken parameter should be set to the previous responses nextToken + // value. Use this token to get the next set of results. NextToken *string `location:"querystring" locationName:"next_token" min:"1" type:"string"` } @@ -6653,6 +6853,10 @@ type ListConfigurationProfilesInput struct { // A token to start the list. Use this token to get the next set of results. NextToken *string `location:"querystring" locationName:"next_token" min:"1" type:"string"` + + // A filter based on the type of configurations that the configuration profile + // contains. A configuration can be a feature flag or a free-form configuration. + Type *string `location:"querystring" locationName:"type" type:"string"` } // String returns the string representation. @@ -6713,6 +6917,12 @@ func (s *ListConfigurationProfilesInput) SetNextToken(v string) *ListConfigurati return s } +// SetType sets the Type field's value. +func (s *ListConfigurationProfilesInput) SetType(v string) *ListConfigurationProfilesInput { + s.Type = &v + return s +} + type ListConfigurationProfilesOutput struct { _ struct{} `type:"structure"` @@ -7321,10 +7531,13 @@ func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForRe type Monitor struct { _ struct{} `type:"structure"` - // ARN of the Amazon CloudWatch alarm. - AlarmArn *string `min:"20" type:"string"` + // Amazon Resource Name (ARN) of the Amazon CloudWatch alarm. + // + // AlarmArn is a required field + AlarmArn *string `min:"1" type:"string" required:"true"` - // ARN of an IAM role for AppConfig to monitor AlarmArn. + // ARN of an Identity and Access Management (IAM) role for AppConfig to monitor + // AlarmArn. AlarmRoleArn *string `min:"20" type:"string"` } @@ -7349,8 +7562,11 @@ func (s Monitor) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *Monitor) Validate() error { invalidParams := request.ErrInvalidParams{Context: "Monitor"} - if s.AlarmArn != nil && len(*s.AlarmArn) < 20 { - invalidParams.Add(request.NewErrParamMinLen("AlarmArn", 20)) + if s.AlarmArn == nil { + invalidParams.Add(request.NewErrParamRequired("AlarmArn")) + } + if s.AlarmArn != nil && len(*s.AlarmArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AlarmArn", 1)) } if s.AlarmRoleArn != nil && len(*s.AlarmRoleArn) < 20 { invalidParams.Add(request.NewErrParamMinLen("AlarmRoleArn", 20)) @@ -7511,7 +7727,7 @@ func (s *ResourceNotFoundException) RequestID() string { } // The number of hosted configuration versions exceeds the limit for the AppConfig -// configuration store. Delete one or more versions and try again. +// hosted configuration store. Delete one or more versions and try again. type ServiceQuotaExceededException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -7746,8 +7962,8 @@ type StartDeploymentOutput struct { // are displayed first. EventLog []*DeploymentEvent `type:"list"` - // The amount of time AppConfig monitored for alarms before considering the - // deployment to be complete and no longer eligible for automatic roll back. + // The amount of time that AppConfig monitored for alarms before considering + // the deployment to be complete and no longer eligible for automatic rollback. FinalBakeTimeInMinutes *int64 `type:"integer"` // The percentage of targets to receive a deployed configuration during each @@ -8013,8 +8229,8 @@ type StopDeploymentOutput struct { // are displayed first. EventLog []*DeploymentEvent `type:"list"` - // The amount of time AppConfig monitored for alarms before considering the - // deployment to be complete and no longer eligible for automatic roll back. + // The amount of time that AppConfig monitored for alarms before considering + // the deployment to be complete and no longer eligible for automatic rollback. FinalBakeTimeInMinutes *int64 `type:"integer"` // The percentage of targets to receive a deployed configuration during each @@ -8592,6 +8808,11 @@ type UpdateConfigurationProfileOutput struct { // specified LocationUri. RetrievalRoleArn *string `min:"20" type:"string"` + // The type of configurations that the configuration profile contains. A configuration + // can be a feature flag used for enabling or disabling new features or a free-form + // configuration used for distributing configurations to your application. + Type *string `type:"string"` + // A list of methods for validating the configuration. Validators []*Validator `type:"list"` } @@ -8650,6 +8871,12 @@ func (s *UpdateConfigurationProfileOutput) SetRetrievalRoleArn(v string) *Update return s } +// SetType sets the Type field's value. +func (s *UpdateConfigurationProfileOutput) SetType(v string) *UpdateConfigurationProfileOutput { + s.Type = &v + return s +} + // SetValidators sets the Validators field's value. func (s *UpdateConfigurationProfileOutput) SetValidators(v []*Validator) *UpdateConfigurationProfileOutput { s.Validators = v @@ -8670,16 +8897,16 @@ type UpdateDeploymentStrategyInput struct { // A description of the deployment strategy. Description *string `type:"string"` - // The amount of time AppConfig monitors for alarms before considering the deployment - // to be complete and no longer eligible for automatic roll back. + // The amount of time that AppConfig monitors for alarms before considering + // the deployment to be complete and no longer eligible for automatic rollback. FinalBakeTimeInMinutes *int64 `type:"integer"` // The percentage of targets to receive a deployed configuration during each // interval. GrowthFactor *float64 `min:"1" type:"float"` - // The algorithm used to define how percentage grows over time. AWS AppConfig - // supports the following growth types: + // The algorithm used to define how percentage grows over time. AppConfig supports + // the following growth types: // // Linear: For this type, AppConfig processes the deployment by increments of // the growth factor evenly distributed over the deployment time. For example, @@ -8788,8 +9015,8 @@ type UpdateDeploymentStrategyOutput struct { // The description of the deployment strategy. Description *string `type:"string"` - // The amount of time AppConfig monitored for alarms before considering the - // deployment to be complete and no longer eligible for automatic roll back. + // The amount of time that AppConfig monitored for alarms before considering + // the deployment to be complete and no longer eligible for automatic rollback. FinalBakeTimeInMinutes *int64 `type:"integer"` // The percentage of targets that received a deployed configuration during each @@ -9164,15 +9391,15 @@ func (s ValidateConfigurationOutput) GoString() string { } // A validator provides a syntactic or semantic check to ensure the configuration -// you want to deploy functions as intended. To validate your application configuration -// data, you provide a schema or a Lambda function that runs against the configuration. -// The configuration deployment or update can only proceed when the configuration -// data is valid. +// that you want to deploy functions as intended. To validate your application +// configuration data, you provide a schema or a Lambda function that runs against +// the configuration. The configuration deployment or update can only proceed +// when the configuration data is valid. type Validator struct { _ struct{} `type:"structure"` - // Either the JSON Schema content or the Amazon Resource Name (ARN) of an AWS - // Lambda function. + // Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda + // function. // // Content is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Validator's @@ -9233,6 +9460,18 @@ func (s *Validator) SetType(v string) *Validator { return s } +const ( + // BadRequestReasonInvalidConfiguration is a BadRequestReason enum value + BadRequestReasonInvalidConfiguration = "InvalidConfiguration" +) + +// BadRequestReason_Values returns all elements of the BadRequestReason enum +func BadRequestReason_Values() []string { + return []string{ + BadRequestReasonInvalidConfiguration, + } +} + const ( // BytesMeasureKilobytes is a BytesMeasure enum value BytesMeasureKilobytes = "KILOBYTES" diff --git a/service/appconfig/doc.go b/service/appconfig/doc.go index 17cc9b27cf..3958d1209b 100644 --- a/service/appconfig/doc.go +++ b/service/appconfig/doc.go @@ -3,12 +3,12 @@ // Package appconfig provides the client and types for making API // requests to Amazon AppConfig. // -// Use AWS AppConfig, a capability of AWS Systems Manager, to create, manage, -// and quickly deploy application configurations. AppConfig supports controlled -// deployments to applications of any size and includes built-in validation -// checks and monitoring. You can use AppConfig with applications hosted on -// Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT -// devices. +// Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, +// manage, and quickly deploy application configurations. AppConfig supports +// controlled deployments to applications of any size and includes built-in +// validation checks and monitoring. You can use AppConfig with applications +// hosted on Amazon EC2 instances, Lambda, containers, mobile applications, +// or IoT devices. // // To prevent errors when deploying application configurations, especially for // production systems where a simple typo could cause an unexpected outage, @@ -26,7 +26,7 @@ // to monitor. Similar to error monitoring, if a deployment triggers an alarm, // AppConfig automatically rolls back to the previous version. // -// AppConfig supports multiple use cases. Here are some examples. +// AppConfig supports multiple use cases. Here are some examples: // // * Application tuning: Use AppConfig to carefully introduce changes to // your application that can only be tested with production traffic. @@ -40,7 +40,7 @@ // * Operational issues: Use AppConfig to reduce stress on your application // when a dependency or other external factor impacts the system. // -// This reference is intended to be used with the AWS AppConfig User Guide (http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html). +// This reference is intended to be used with the AppConfig User Guide (http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html). // // See https://docs.aws.amazon.com/goto/WebAPI/appconfig-2019-10-09 for more information on this service. // diff --git a/service/appconfig/errors.go b/service/appconfig/errors.go index 487e6617cb..3f2fb5bc06 100644 --- a/service/appconfig/errors.go +++ b/service/appconfig/errors.go @@ -11,7 +11,8 @@ const ( // ErrCodeBadRequestException for service response error code // "BadRequestException". // - // The input fails to satisfy the constraints specified by an AWS service. + // The input fails to satisfy the constraints specified by an Amazon Web Services + // service. ErrCodeBadRequestException = "BadRequestException" // ErrCodeConflictException for service response error code @@ -43,7 +44,7 @@ const ( // "ServiceQuotaExceededException". // // The number of hosted configuration versions exceeds the limit for the AppConfig - // configuration store. Delete one or more versions and try again. + // hosted configuration store. Delete one or more versions and try again. ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" ) diff --git a/service/appconfig/examples_test.go b/service/appconfig/examples_test.go new file mode 100644 index 0000000000..8dc2069df1 --- /dev/null +++ b/service/appconfig/examples_test.go @@ -0,0 +1,1194 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package appconfig_test + +import ( + "fmt" + "strings" + "time" + + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/awserr" + "github.com/aws/aws-sdk-go/aws/session" + "github.com/aws/aws-sdk-go/service/appconfig" +) + +var _ time.Duration +var _ strings.Reader +var _ aws.Config + +func parseTime(layout, value string) *time.Time { + t, err := time.Parse(layout, value) + if err != nil { + panic(err) + } + return &t +} + +// To create an application +// +// The following create-application example creates an application in AWS AppConfig. +func ExampleAppConfig_CreateApplication_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.CreateApplicationInput{ + Description: aws.String("An application used for creating an example."), + Name: aws.String("example-application"), + } + + result, err := svc.CreateApplication(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To create a configuration profile +// +// The following create-configuration-profile example creates a configuration profile +// using a configuration stored in Parameter Store, a capability of Systems Manager. +func ExampleAppConfig_CreateConfigurationProfile_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.CreateConfigurationProfileInput{ + ApplicationId: aws.String("339ohji"), + LocationUri: aws.String("ssm-parameter://Example-Parameter"), + Name: aws.String("Example-Configuration-Profile"), + RetrievalRoleArn: aws.String("arn:aws:iam::111122223333:role/Example-App-Config-Role"), + } + + result, err := svc.CreateConfigurationProfile(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To create a deployment strategy +// +// The following create-deployment-strategy example creates a deployment strategy called +// Example-Deployment that takes 15 minutes and deploys the configuration to 25% of +// the application at a time. The strategy is also copied to an SSM Document. +func ExampleAppConfig_CreateDeploymentStrategy_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.CreateDeploymentStrategyInput{ + DeploymentDurationInMinutes: aws.Int64(15), + GrowthFactor: aws.Float64(25.000000), + Name: aws.String("Example-Deployment"), + ReplicateTo: aws.String("SSM_DOCUMENT"), + } + + result, err := svc.CreateDeploymentStrategy(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To create an environment +// +// The following create-environment example creates an AWS AppConfig environment named +// Example-Environment using the application you created using create-application +func ExampleAppConfig_CreateEnvironment_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.CreateEnvironmentInput{ + ApplicationId: aws.String("339ohji"), + Name: aws.String("Example-Environment"), + } + + result, err := svc.CreateEnvironment(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To create a hosted configuration version +// +// The following create-hosted-configuration-version example creates a new configuration +// in the AWS AppConfig configuration store. +func ExampleAppConfig_CreateHostedConfigurationVersion_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.CreateHostedConfigurationVersionInput{ + ApplicationId: aws.String("339ohji"), + ConfigurationProfileId: aws.String("ur8hx2f"), + Content: []byte("eyAiTmFtZSI6ICJFeGFtcGxlQXBwbGljYXRpb24iLCAiSWQiOiBFeGFtcGxlSUQsICJSYW5rIjogNyB9"), + ContentType: aws.String("text"), + LatestVersionNumber: aws.Int64(1), + } + + result, err := svc.CreateHostedConfigurationVersion(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + case appconfig.ErrCodeServiceQuotaExceededException: + fmt.Println(appconfig.ErrCodeServiceQuotaExceededException, aerr.Error()) + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeConflictException: + fmt.Println(appconfig.ErrCodeConflictException, aerr.Error()) + case appconfig.ErrCodePayloadTooLargeException: + fmt.Println(appconfig.ErrCodePayloadTooLargeException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To delete an application +// +// The following delete-application example deletes the specified application. +func ExampleAppConfig_DeleteApplication_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.DeleteApplicationInput{ + ApplicationId: aws.String("339ohji"), + } + + result, err := svc.DeleteApplication(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To delete a configuration profile +// +// The following delete-configuration-profile example deletes the specified configuration +// profile. +func ExampleAppConfig_DeleteConfigurationProfile_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.DeleteConfigurationProfileInput{ + ApplicationId: aws.String("339ohji"), + ConfigurationProfileId: aws.String("ur8hx2f"), + } + + result, err := svc.DeleteConfigurationProfile(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeConflictException: + fmt.Println(appconfig.ErrCodeConflictException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To delete a deployment strategy +// +// The following delete-deployment-strategy example deletes the specified deployment +// strategy. +func ExampleAppConfig_DeleteDeploymentStrategy_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.DeleteDeploymentStrategyInput{ + DeploymentStrategyId: aws.String("1225qzk"), + } + + result, err := svc.DeleteDeploymentStrategy(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To delete an environment +// +// The following delete-environment example deletes the specified application environment. +func ExampleAppConfig_DeleteEnvironment_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.DeleteEnvironmentInput{ + ApplicationId: aws.String("339ohji"), + EnvironmentId: aws.String("54j1r29"), + } + + result, err := svc.DeleteEnvironment(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeConflictException: + fmt.Println(appconfig.ErrCodeConflictException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To delete a hosted configuration version +// +// The following delete-hosted-configuration-version example deletes a configuration +// version hosted in the AWS AppConfig configuration store. +func ExampleAppConfig_DeleteHostedConfigurationVersion_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.DeleteHostedConfigurationVersionInput{ + ApplicationId: aws.String("339ohji"), + ConfigurationProfileId: aws.String("ur8hx2f"), + VersionNumber: aws.Int64(1), + } + + result, err := svc.DeleteHostedConfigurationVersion(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To list details of an application +// +// The following get-application example lists the details of the specified application. +func ExampleAppConfig_GetApplication_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.GetApplicationInput{ + ApplicationId: aws.String("339ohji"), + } + + result, err := svc.GetApplication(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To retrieve configuration details +// +// The following get-configuration example returns the configuration details of the +// example application. On subsequent calls to get-configuration, use the client-configuration-version +// parameter to only update the configuration of your application if the version has +// changed. Only updating the configuration when the version has changed avoids excess +// charges incurred by calling get-configuration. +func ExampleAppConfig_GetConfiguration_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.GetConfigurationInput{ + Application: aws.String("example-application"), + ClientId: aws.String("example-id"), + Configuration: aws.String("Example-Configuration-Profile"), + Environment: aws.String("Example-Environment"), + } + + result, err := svc.GetConfiguration(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To retrieve configuration profile details +// +// The following get-configuration-profile example returns the details of the specified +// configuration profile. +func ExampleAppConfig_GetConfigurationProfile_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.GetConfigurationProfileInput{ + ApplicationId: aws.String("339ohji"), + ConfigurationProfileId: aws.String("ur8hx2f"), + } + + result, err := svc.GetConfigurationProfile(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To retrieve deployment details +// +// The following get-deployment example lists details of the deployment to the application +// in the specified environment and deployment. +func ExampleAppConfig_GetDeployment_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.GetDeploymentInput{ + ApplicationId: aws.String("339ohji"), + DeploymentNumber: aws.Int64(1), + EnvironmentId: aws.String("54j1r29"), + } + + result, err := svc.GetDeployment(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To retrieve details of a deployment strategy +// +// The following get-deployment-strategy example lists the details of the specified +// deployment strategy. +func ExampleAppConfig_GetDeploymentStrategy_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.GetDeploymentStrategyInput{ + DeploymentStrategyId: aws.String("1225qzk"), + } + + result, err := svc.GetDeploymentStrategy(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To retrieve environment details +// +// The following get-environment example returns the details and state of the specified +// environment. +func ExampleAppConfig_GetEnvironment_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.GetEnvironmentInput{ + ApplicationId: aws.String("339ohji"), + EnvironmentId: aws.String("54j1r29"), + } + + result, err := svc.GetEnvironment(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To retrieve hosted configuration details +// +// The following get-hosted-configuration-version example retrieves the configuration +// details of the AWS AppConfig hosted configuration. +func ExampleAppConfig_GetHostedConfigurationVersion_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.GetHostedConfigurationVersionInput{ + ApplicationId: aws.String("339ohji"), + ConfigurationProfileId: aws.String("ur8hx2f"), + VersionNumber: aws.Int64(1), + } + + result, err := svc.GetHostedConfigurationVersion(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To list the available applications +// +// The following list-applications example lists the available applications in your +// AWS account. +func ExampleAppConfig_ListApplications_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.ListApplicationsInput{} + + result, err := svc.ListApplications(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To list the available configuration profiles +// +// The following list-configuration-profiles example lists the available configuration +// profiles for the specified application. +func ExampleAppConfig_ListConfigurationProfiles_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.ListConfigurationProfilesInput{ + ApplicationId: aws.String("339ohji"), + } + + result, err := svc.ListConfigurationProfiles(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To list the available deployment strategies +// +// The following list-deployment-strategies example lists the available deployment strategies +// in your AWS account. +func ExampleAppConfig_ListDeploymentStrategies_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.ListDeploymentStrategiesInput{} + + result, err := svc.ListDeploymentStrategies(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To list the available deployments +// +// The following list-deployments example lists the available deployments in your AWS +// account for the specified application and environment. +func ExampleAppConfig_ListDeployments_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.ListDeploymentsInput{ + ApplicationId: aws.String("339ohji"), + EnvironmentId: aws.String("54j1r29"), + } + + result, err := svc.ListDeployments(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To list the available environments +// +// The following list-environments example lists the available environments in your +// AWS account for the specified application. +func ExampleAppConfig_ListEnvironments_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.ListEnvironmentsInput{ + ApplicationId: aws.String("339ohji"), + } + + result, err := svc.ListEnvironments(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To list the available hosted configuration versions +// +// The following list-hosted-configuration-versions example lists the configurations +// versions hosted in the AWS AppConfig hosted configuration store for the specified +// application and configuration profile. +func ExampleAppConfig_ListHostedConfigurationVersions_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.ListHostedConfigurationVersionsInput{ + ApplicationId: aws.String("339ohji"), + ConfigurationProfileId: aws.String("ur8hx2f"), + } + + result, err := svc.ListHostedConfigurationVersions(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To list the tags of an application +// +// The following list-tags-for-resource example lists the tags of a specified application. +func ExampleAppConfig_ListTagsForResource_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.ListTagsForResourceInput{ + ResourceArn: aws.String("arn:aws:appconfig:us-east-1:111122223333:application/339ohji"), + } + + result, err := svc.ListTagsForResource(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To start a configuration deployment +// +// The following start-deployment example starts a deployment to the application using +// the specified environment, deployment strategy, and configuration profile. +func ExampleAppConfig_StartDeployment_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.StartDeploymentInput{ + ApplicationId: aws.String("339ohji"), + ConfigurationProfileId: aws.String("ur8hx2f"), + ConfigurationVersion: aws.String("1"), + DeploymentStrategyId: aws.String("1225qzk"), + Description: aws.String(""), + EnvironmentId: aws.String("54j1r29"), + Tags: map[string]*string{}, + } + + result, err := svc.StartDeployment(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeConflictException: + fmt.Println(appconfig.ErrCodeConflictException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To stop configuration deployment +// +// The following stop-deployment example stops the deployment of an application configuration +// to the specified environment. +func ExampleAppConfig_StopDeployment_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.StopDeploymentInput{ + ApplicationId: aws.String("339ohji"), + DeploymentNumber: aws.Int64(2), + EnvironmentId: aws.String("54j1r29"), + } + + result, err := svc.StopDeployment(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To tag an application +// +// The following tag-resource example tags an application resource. +func ExampleAppConfig_TagResource_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.TagResourceInput{ + ResourceArn: aws.String("arn:aws:appconfig:us-east-1:111122223333:application/339ohji"), + Tags: map[string]*string{ + "group1": aws.String("1"), + }, + } + + result, err := svc.TagResource(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To remove a tag from an application +// +// The following untag-resource example removes the group1 tag from the specified application. +func ExampleAppConfig_UntagResource_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.UntagResourceInput{ + ResourceArn: aws.String("arn:aws:appconfig:us-east-1:111122223333:application/339ohji"), + TagKeys: []*string{ + aws.String("group1"), + }, + } + + result, err := svc.UntagResource(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To update an application +// +// The following update-application example updates the name of the specified application. +func ExampleAppConfig_UpdateApplication_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.UpdateApplicationInput{ + ApplicationId: aws.String("339ohji"), + Description: aws.String(""), + Name: aws.String("Example-Application"), + } + + result, err := svc.UpdateApplication(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To update a configuration profile +// +// The following update-configuration-profile example updates the description of the +// specified configuration profile. +func ExampleAppConfig_UpdateConfigurationProfile_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.UpdateConfigurationProfileInput{ + ApplicationId: aws.String("339ohji"), + ConfigurationProfileId: aws.String("ur8hx2f"), + Description: aws.String("Configuration profile used for examples."), + } + + result, err := svc.UpdateConfigurationProfile(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To update a deployment strategy +// +// The following update-deployment-strategy example updates final bake time to 20 minutes +// in the specified deployment strategy. :: +func ExampleAppConfig_UpdateDeploymentStrategy_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.UpdateDeploymentStrategyInput{ + DeploymentStrategyId: aws.String("1225qzk"), + FinalBakeTimeInMinutes: aws.Int64(20), + } + + result, err := svc.UpdateDeploymentStrategy(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To update an environment +// +// The following update-environment example updates an environment's description. +func ExampleAppConfig_UpdateEnvironment_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.UpdateEnvironmentInput{ + ApplicationId: aws.String("339ohji"), + Description: aws.String("An environment for examples."), + EnvironmentId: aws.String("54j1r29"), + } + + result, err := svc.UpdateEnvironment(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} + +// To validate a configuration +// +// The following validate-configuration example uses the validators in a configuration +// profile to validate a configuration. +func ExampleAppConfig_ValidateConfiguration_shared00() { + svc := appconfig.New(session.New()) + input := &appconfig.ValidateConfigurationInput{ + ApplicationId: aws.String("abc1234"), + ConfigurationProfileId: aws.String("ur8hx2f"), + ConfigurationVersion: aws.String("1"), + } + + result, err := svc.ValidateConfiguration(input) + if err != nil { + if aerr, ok := err.(awserr.Error); ok { + switch aerr.Code() { + case appconfig.ErrCodeBadRequestException: + fmt.Println(appconfig.ErrCodeBadRequestException, aerr.Error()) + case appconfig.ErrCodeResourceNotFoundException: + fmt.Println(appconfig.ErrCodeResourceNotFoundException, aerr.Error()) + case appconfig.ErrCodeInternalServerException: + fmt.Println(appconfig.ErrCodeInternalServerException, aerr.Error()) + default: + fmt.Println(aerr.Error()) + } + } else { + // Print the error, cast err to awserr.Error to get the Code and + // Message from an error. + fmt.Println(err.Error()) + } + return + } + + fmt.Println(result) +} diff --git a/service/auditmanager/api.go b/service/auditmanager/api.go index f9e88aed8e..2e394ddfe1 100644 --- a/service/auditmanager/api.go +++ b/service/auditmanager/api.go @@ -3009,6 +3009,180 @@ func (c *AuditManager) GetEvidenceFoldersByAssessmentControlPagesWithContext(ctx return p.Err() } +const opGetInsights = "GetInsights" + +// GetInsightsRequest generates a "aws/request.Request" representing the +// client's request for the GetInsights operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetInsights for more information on using the GetInsights +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetInsightsRequest method. +// req, resp := client.GetInsightsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetInsights +func (c *AuditManager) GetInsightsRequest(input *GetInsightsInput) (req *request.Request, output *GetInsightsOutput) { + op := &request.Operation{ + Name: opGetInsights, + HTTPMethod: "GET", + HTTPPath: "/insights", + } + + if input == nil { + input = &GetInsightsInput{} + } + + output = &GetInsightsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetInsights API operation for AWS Audit Manager. +// +// Gets the latest analytics data for all your current active assessments. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetInsights for usage and error information. +// +// Returned Error Types: +// * AccessDeniedException +// Your account isn't registered with Audit Manager. Check the delegated administrator +// setup on the Audit Manager settings page, and try again. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetInsights +func (c *AuditManager) GetInsights(input *GetInsightsInput) (*GetInsightsOutput, error) { + req, out := c.GetInsightsRequest(input) + return out, req.Send() +} + +// GetInsightsWithContext is the same as GetInsights with the addition of +// the ability to pass a context and additional request options. +// +// See GetInsights for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetInsightsWithContext(ctx aws.Context, input *GetInsightsInput, opts ...request.Option) (*GetInsightsOutput, error) { + req, out := c.GetInsightsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetInsightsByAssessment = "GetInsightsByAssessment" + +// GetInsightsByAssessmentRequest generates a "aws/request.Request" representing the +// client's request for the GetInsightsByAssessment operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetInsightsByAssessment for more information on using the GetInsightsByAssessment +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetInsightsByAssessmentRequest method. +// req, resp := client.GetInsightsByAssessmentRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetInsightsByAssessment +func (c *AuditManager) GetInsightsByAssessmentRequest(input *GetInsightsByAssessmentInput) (req *request.Request, output *GetInsightsByAssessmentOutput) { + op := &request.Operation{ + Name: opGetInsightsByAssessment, + HTTPMethod: "GET", + HTTPPath: "/insights/assessments/{assessmentId}", + } + + if input == nil { + input = &GetInsightsByAssessmentInput{} + } + + output = &GetInsightsByAssessmentOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetInsightsByAssessment API operation for AWS Audit Manager. +// +// Gets the latest analytics data for a specific active assessment. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation GetInsightsByAssessment for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * ResourceNotFoundException +// The resource that's specified in the request can't be found. +// +// * AccessDeniedException +// Your account isn't registered with Audit Manager. Check the delegated administrator +// setup on the Audit Manager settings page, and try again. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/GetInsightsByAssessment +func (c *AuditManager) GetInsightsByAssessment(input *GetInsightsByAssessmentInput) (*GetInsightsByAssessmentOutput, error) { + req, out := c.GetInsightsByAssessmentRequest(input) + return out, req.Send() +} + +// GetInsightsByAssessmentWithContext is the same as GetInsightsByAssessment with the addition of +// the ability to pass a context and additional request options. +// +// See GetInsightsByAssessment for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) GetInsightsByAssessmentWithContext(ctx aws.Context, input *GetInsightsByAssessmentInput, opts ...request.Option) (*GetInsightsByAssessmentOutput, error) { + req, out := c.GetInsightsByAssessmentRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opGetOrganizationAdminAccount = "GetOrganizationAdminAccount" // GetOrganizationAdminAccountRequest generates a "aws/request.Request" representing the @@ -3272,6 +3446,160 @@ func (c *AuditManager) GetSettingsWithContext(ctx aws.Context, input *GetSetting return out, req.Send() } +const opListAssessmentControlInsightsByControlDomain = "ListAssessmentControlInsightsByControlDomain" + +// ListAssessmentControlInsightsByControlDomainRequest generates a "aws/request.Request" representing the +// client's request for the ListAssessmentControlInsightsByControlDomain operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListAssessmentControlInsightsByControlDomain for more information on using the ListAssessmentControlInsightsByControlDomain +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListAssessmentControlInsightsByControlDomainRequest method. +// req, resp := client.ListAssessmentControlInsightsByControlDomainRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain +func (c *AuditManager) ListAssessmentControlInsightsByControlDomainRequest(input *ListAssessmentControlInsightsByControlDomainInput) (req *request.Request, output *ListAssessmentControlInsightsByControlDomainOutput) { + op := &request.Operation{ + Name: opListAssessmentControlInsightsByControlDomain, + HTTPMethod: "GET", + HTTPPath: "/insights/controls-by-assessment", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListAssessmentControlInsightsByControlDomainInput{} + } + + output = &ListAssessmentControlInsightsByControlDomainOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListAssessmentControlInsightsByControlDomain API operation for AWS Audit Manager. +// +// Lists the latest analytics data for controls within a specific control domain +// and a specific active assessment. +// +// Control insights are listed only if the control belongs to the control domain +// and assessment that was specified. Moreover, the control must have collected +// evidence on the lastUpdated date of controlInsightsByAssessment. If neither +// of these conditions are met, no data is listed for that control. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation ListAssessmentControlInsightsByControlDomain for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * ResourceNotFoundException +// The resource that's specified in the request can't be found. +// +// * AccessDeniedException +// Your account isn't registered with Audit Manager. Check the delegated administrator +// setup on the Audit Manager settings page, and try again. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListAssessmentControlInsightsByControlDomain +func (c *AuditManager) ListAssessmentControlInsightsByControlDomain(input *ListAssessmentControlInsightsByControlDomainInput) (*ListAssessmentControlInsightsByControlDomainOutput, error) { + req, out := c.ListAssessmentControlInsightsByControlDomainRequest(input) + return out, req.Send() +} + +// ListAssessmentControlInsightsByControlDomainWithContext is the same as ListAssessmentControlInsightsByControlDomain with the addition of +// the ability to pass a context and additional request options. +// +// See ListAssessmentControlInsightsByControlDomain for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListAssessmentControlInsightsByControlDomainWithContext(ctx aws.Context, input *ListAssessmentControlInsightsByControlDomainInput, opts ...request.Option) (*ListAssessmentControlInsightsByControlDomainOutput, error) { + req, out := c.ListAssessmentControlInsightsByControlDomainRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListAssessmentControlInsightsByControlDomainPages iterates over the pages of a ListAssessmentControlInsightsByControlDomain operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListAssessmentControlInsightsByControlDomain method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListAssessmentControlInsightsByControlDomain operation. +// pageNum := 0 +// err := client.ListAssessmentControlInsightsByControlDomainPages(params, +// func(page *auditmanager.ListAssessmentControlInsightsByControlDomainOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AuditManager) ListAssessmentControlInsightsByControlDomainPages(input *ListAssessmentControlInsightsByControlDomainInput, fn func(*ListAssessmentControlInsightsByControlDomainOutput, bool) bool) error { + return c.ListAssessmentControlInsightsByControlDomainPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListAssessmentControlInsightsByControlDomainPagesWithContext same as ListAssessmentControlInsightsByControlDomainPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListAssessmentControlInsightsByControlDomainPagesWithContext(ctx aws.Context, input *ListAssessmentControlInsightsByControlDomainInput, fn func(*ListAssessmentControlInsightsByControlDomainOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListAssessmentControlInsightsByControlDomainInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListAssessmentControlInsightsByControlDomainRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListAssessmentControlInsightsByControlDomainOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListAssessmentFrameworkShareRequests = "ListAssessmentFrameworkShareRequests" // ListAssessmentFrameworkShareRequestsRequest generates a "aws/request.Request" representing the @@ -3854,37 +4182,37 @@ func (c *AuditManager) ListAssessmentsPagesWithContext(ctx aws.Context, input *L return p.Err() } -const opListControls = "ListControls" +const opListControlDomainInsights = "ListControlDomainInsights" -// ListControlsRequest generates a "aws/request.Request" representing the -// client's request for the ListControls operation. The "output" return +// ListControlDomainInsightsRequest generates a "aws/request.Request" representing the +// client's request for the ListControlDomainInsights operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListControls for more information on using the ListControls +// See ListControlDomainInsights for more information on using the ListControlDomainInsights // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the ListControlsRequest method. -// req, resp := client.ListControlsRequest(params) +// // Example sending a request using the ListControlDomainInsightsRequest method. +// req, resp := client.ListControlDomainInsightsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControls -func (c *AuditManager) ListControlsRequest(input *ListControlsInput) (req *request.Request, output *ListControlsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlDomainInsights +func (c *AuditManager) ListControlDomainInsightsRequest(input *ListControlDomainInsightsInput) (req *request.Request, output *ListControlDomainInsightsOutput) { op := &request.Operation{ - Name: opListControls, + Name: opListControlDomainInsights, HTTPMethod: "GET", - HTTPPath: "/controls", + HTTPPath: "/insights/control-domains", Paginator: &request.Paginator{ InputTokens: []string{"nextToken"}, OutputTokens: []string{"nextToken"}, @@ -3894,96 +4222,104 @@ func (c *AuditManager) ListControlsRequest(input *ListControlsInput) (req *reque } if input == nil { - input = &ListControlsInput{} + input = &ListControlDomainInsightsInput{} } - output = &ListControlsOutput{} + output = &ListControlDomainInsightsOutput{} req = c.newRequest(op, input, output) return } -// ListControls API operation for AWS Audit Manager. +// ListControlDomainInsights API operation for AWS Audit Manager. // -// Returns a list of controls from Audit Manager. +// Lists the latest analytics data for control domains across all of your active +// assessments. +// +// A control domain is listed only if at least one of the controls within that +// domain collected evidence on the lastUpdated date of controlDomainInsights. +// If this condition isn’t met, no data is listed for that control domain. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation ListControls for usage and error information. +// API operation ListControlDomainInsights for usage and error information. // // Returned Error Types: +// * ResourceNotFoundException +// The resource that's specified in the request can't be found. +// // * AccessDeniedException // Your account isn't registered with Audit Manager. Check the delegated administrator // setup on the Audit Manager settings page, and try again. // -// * ValidationException -// The request has invalid or missing parameters. -// // * InternalServerException // An internal service error occurred during the processing of your request. // Try again later. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControls -func (c *AuditManager) ListControls(input *ListControlsInput) (*ListControlsOutput, error) { - req, out := c.ListControlsRequest(input) +// * ValidationException +// The request has invalid or missing parameters. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlDomainInsights +func (c *AuditManager) ListControlDomainInsights(input *ListControlDomainInsightsInput) (*ListControlDomainInsightsOutput, error) { + req, out := c.ListControlDomainInsightsRequest(input) return out, req.Send() } -// ListControlsWithContext is the same as ListControls with the addition of +// ListControlDomainInsightsWithContext is the same as ListControlDomainInsights with the addition of // the ability to pass a context and additional request options. // -// See ListControls for details on how to use this API operation. +// See ListControlDomainInsights for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) ListControlsWithContext(ctx aws.Context, input *ListControlsInput, opts ...request.Option) (*ListControlsOutput, error) { - req, out := c.ListControlsRequest(input) +func (c *AuditManager) ListControlDomainInsightsWithContext(ctx aws.Context, input *ListControlDomainInsightsInput, opts ...request.Option) (*ListControlDomainInsightsOutput, error) { + req, out := c.ListControlDomainInsightsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListControlsPages iterates over the pages of a ListControls operation, +// ListControlDomainInsightsPages iterates over the pages of a ListControlDomainInsights operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListControls method for more information on how to use this operation. +// See ListControlDomainInsights method for more information on how to use this operation. // // Note: This operation can generate multiple requests to a service. // -// // Example iterating over at most 3 pages of a ListControls operation. +// // Example iterating over at most 3 pages of a ListControlDomainInsights operation. // pageNum := 0 -// err := client.ListControlsPages(params, -// func(page *auditmanager.ListControlsOutput, lastPage bool) bool { +// err := client.ListControlDomainInsightsPages(params, +// func(page *auditmanager.ListControlDomainInsightsOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) // -func (c *AuditManager) ListControlsPages(input *ListControlsInput, fn func(*ListControlsOutput, bool) bool) error { - return c.ListControlsPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *AuditManager) ListControlDomainInsightsPages(input *ListControlDomainInsightsInput, fn func(*ListControlDomainInsightsOutput, bool) bool) error { + return c.ListControlDomainInsightsPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListControlsPagesWithContext same as ListControlsPages except +// ListControlDomainInsightsPagesWithContext same as ListControlDomainInsightsPages except // it takes a Context and allows setting request options on the pages. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) ListControlsPagesWithContext(ctx aws.Context, input *ListControlsInput, fn func(*ListControlsOutput, bool) bool, opts ...request.Option) error { +func (c *AuditManager) ListControlDomainInsightsPagesWithContext(ctx aws.Context, input *ListControlDomainInsightsInput, fn func(*ListControlDomainInsightsOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListControlsInput + var inCpy *ListControlDomainInsightsInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListControlsRequest(inCpy) + req, _ := c.ListControlDomainInsightsRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -3991,7 +4327,7 @@ func (c *AuditManager) ListControlsPagesWithContext(ctx aws.Context, input *List } for p.Next() { - if !fn(p.Page().(*ListControlsOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListControlDomainInsightsOutput), !p.HasNextPage()) { break } } @@ -3999,37 +4335,37 @@ func (c *AuditManager) ListControlsPagesWithContext(ctx aws.Context, input *List return p.Err() } -const opListKeywordsForDataSource = "ListKeywordsForDataSource" +const opListControlDomainInsightsByAssessment = "ListControlDomainInsightsByAssessment" -// ListKeywordsForDataSourceRequest generates a "aws/request.Request" representing the -// client's request for the ListKeywordsForDataSource operation. The "output" return +// ListControlDomainInsightsByAssessmentRequest generates a "aws/request.Request" representing the +// client's request for the ListControlDomainInsightsByAssessment operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListKeywordsForDataSource for more information on using the ListKeywordsForDataSource +// See ListControlDomainInsightsByAssessment for more information on using the ListControlDomainInsightsByAssessment // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the ListKeywordsForDataSourceRequest method. -// req, resp := client.ListKeywordsForDataSourceRequest(params) +// // Example sending a request using the ListControlDomainInsightsByAssessmentRequest method. +// req, resp := client.ListControlDomainInsightsByAssessmentRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListKeywordsForDataSource -func (c *AuditManager) ListKeywordsForDataSourceRequest(input *ListKeywordsForDataSourceInput) (req *request.Request, output *ListKeywordsForDataSourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment +func (c *AuditManager) ListControlDomainInsightsByAssessmentRequest(input *ListControlDomainInsightsByAssessmentInput) (req *request.Request, output *ListControlDomainInsightsByAssessmentOutput) { op := &request.Operation{ - Name: opListKeywordsForDataSource, + Name: opListControlDomainInsightsByAssessment, HTTPMethod: "GET", - HTTPPath: "/dataSourceKeywords", + HTTPPath: "/insights/control-domains-by-assessment", Paginator: &request.Paginator{ InputTokens: []string{"nextToken"}, OutputTokens: []string{"nextToken"}, @@ -4039,97 +4375,103 @@ func (c *AuditManager) ListKeywordsForDataSourceRequest(input *ListKeywordsForDa } if input == nil { - input = &ListKeywordsForDataSourceInput{} + input = &ListControlDomainInsightsByAssessmentInput{} } - output = &ListKeywordsForDataSourceOutput{} + output = &ListControlDomainInsightsByAssessmentOutput{} req = c.newRequest(op, input, output) return } -// ListKeywordsForDataSource API operation for AWS Audit Manager. +// ListControlDomainInsightsByAssessment API operation for AWS Audit Manager. // -// Returns a list of keywords that are pre-mapped to the specified control data -// source. +// Lists analytics data for control domains within a specified active assessment. +// +// A control domain is listed only if at least one of the controls within that +// domain collected evidence on the lastUpdated date of controlDomainInsights. +// If this condition isn’t met, no data is listed for that domain. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation ListKeywordsForDataSource for usage and error information. +// API operation ListControlDomainInsightsByAssessment for usage and error information. // // Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * ResourceNotFoundException +// The resource that's specified in the request can't be found. +// // * AccessDeniedException // Your account isn't registered with Audit Manager. Check the delegated administrator // setup on the Audit Manager settings page, and try again. // -// * ValidationException -// The request has invalid or missing parameters. -// // * InternalServerException // An internal service error occurred during the processing of your request. // Try again later. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListKeywordsForDataSource -func (c *AuditManager) ListKeywordsForDataSource(input *ListKeywordsForDataSourceInput) (*ListKeywordsForDataSourceOutput, error) { - req, out := c.ListKeywordsForDataSourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlDomainInsightsByAssessment +func (c *AuditManager) ListControlDomainInsightsByAssessment(input *ListControlDomainInsightsByAssessmentInput) (*ListControlDomainInsightsByAssessmentOutput, error) { + req, out := c.ListControlDomainInsightsByAssessmentRequest(input) return out, req.Send() } -// ListKeywordsForDataSourceWithContext is the same as ListKeywordsForDataSource with the addition of +// ListControlDomainInsightsByAssessmentWithContext is the same as ListControlDomainInsightsByAssessment with the addition of // the ability to pass a context and additional request options. // -// See ListKeywordsForDataSource for details on how to use this API operation. +// See ListControlDomainInsightsByAssessment for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) ListKeywordsForDataSourceWithContext(ctx aws.Context, input *ListKeywordsForDataSourceInput, opts ...request.Option) (*ListKeywordsForDataSourceOutput, error) { - req, out := c.ListKeywordsForDataSourceRequest(input) +func (c *AuditManager) ListControlDomainInsightsByAssessmentWithContext(ctx aws.Context, input *ListControlDomainInsightsByAssessmentInput, opts ...request.Option) (*ListControlDomainInsightsByAssessmentOutput, error) { + req, out := c.ListControlDomainInsightsByAssessmentRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListKeywordsForDataSourcePages iterates over the pages of a ListKeywordsForDataSource operation, +// ListControlDomainInsightsByAssessmentPages iterates over the pages of a ListControlDomainInsightsByAssessment operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListKeywordsForDataSource method for more information on how to use this operation. +// See ListControlDomainInsightsByAssessment method for more information on how to use this operation. // // Note: This operation can generate multiple requests to a service. // -// // Example iterating over at most 3 pages of a ListKeywordsForDataSource operation. +// // Example iterating over at most 3 pages of a ListControlDomainInsightsByAssessment operation. // pageNum := 0 -// err := client.ListKeywordsForDataSourcePages(params, -// func(page *auditmanager.ListKeywordsForDataSourceOutput, lastPage bool) bool { +// err := client.ListControlDomainInsightsByAssessmentPages(params, +// func(page *auditmanager.ListControlDomainInsightsByAssessmentOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) // -func (c *AuditManager) ListKeywordsForDataSourcePages(input *ListKeywordsForDataSourceInput, fn func(*ListKeywordsForDataSourceOutput, bool) bool) error { - return c.ListKeywordsForDataSourcePagesWithContext(aws.BackgroundContext(), input, fn) +func (c *AuditManager) ListControlDomainInsightsByAssessmentPages(input *ListControlDomainInsightsByAssessmentInput, fn func(*ListControlDomainInsightsByAssessmentOutput, bool) bool) error { + return c.ListControlDomainInsightsByAssessmentPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListKeywordsForDataSourcePagesWithContext same as ListKeywordsForDataSourcePages except +// ListControlDomainInsightsByAssessmentPagesWithContext same as ListControlDomainInsightsByAssessmentPages except // it takes a Context and allows setting request options on the pages. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) ListKeywordsForDataSourcePagesWithContext(ctx aws.Context, input *ListKeywordsForDataSourceInput, fn func(*ListKeywordsForDataSourceOutput, bool) bool, opts ...request.Option) error { +func (c *AuditManager) ListControlDomainInsightsByAssessmentPagesWithContext(ctx aws.Context, input *ListControlDomainInsightsByAssessmentInput, fn func(*ListControlDomainInsightsByAssessmentOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListKeywordsForDataSourceInput + var inCpy *ListControlDomainInsightsByAssessmentInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListKeywordsForDataSourceRequest(inCpy) + req, _ := c.ListControlDomainInsightsByAssessmentRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -4137,7 +4479,7 @@ func (c *AuditManager) ListKeywordsForDataSourcePagesWithContext(ctx aws.Context } for p.Next() { - if !fn(p.Page().(*ListKeywordsForDataSourceOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListControlDomainInsightsByAssessmentOutput), !p.HasNextPage()) { break } } @@ -4145,37 +4487,37 @@ func (c *AuditManager) ListKeywordsForDataSourcePagesWithContext(ctx aws.Context return p.Err() } -const opListNotifications = "ListNotifications" +const opListControlInsightsByControlDomain = "ListControlInsightsByControlDomain" -// ListNotificationsRequest generates a "aws/request.Request" representing the -// client's request for the ListNotifications operation. The "output" return +// ListControlInsightsByControlDomainRequest generates a "aws/request.Request" representing the +// client's request for the ListControlInsightsByControlDomain operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListNotifications for more information on using the ListNotifications +// See ListControlInsightsByControlDomain for more information on using the ListControlInsightsByControlDomain // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the ListNotificationsRequest method. -// req, resp := client.ListNotificationsRequest(params) +// // Example sending a request using the ListControlInsightsByControlDomainRequest method. +// req, resp := client.ListControlInsightsByControlDomainRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListNotifications -func (c *AuditManager) ListNotificationsRequest(input *ListNotificationsInput) (req *request.Request, output *ListNotificationsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlInsightsByControlDomain +func (c *AuditManager) ListControlInsightsByControlDomainRequest(input *ListControlInsightsByControlDomainInput) (req *request.Request, output *ListControlInsightsByControlDomainOutput) { op := &request.Operation{ - Name: opListNotifications, + Name: opListControlInsightsByControlDomain, HTTPMethod: "GET", - HTTPPath: "/notifications", + HTTPPath: "/insights/controls", Paginator: &request.Paginator{ InputTokens: []string{"nextToken"}, OutputTokens: []string{"nextToken"}, @@ -4185,96 +4527,105 @@ func (c *AuditManager) ListNotificationsRequest(input *ListNotificationsInput) ( } if input == nil { - input = &ListNotificationsInput{} + input = &ListControlInsightsByControlDomainInput{} } - output = &ListNotificationsOutput{} + output = &ListControlInsightsByControlDomainOutput{} req = c.newRequest(op, input, output) return } -// ListNotifications API operation for AWS Audit Manager. +// ListControlInsightsByControlDomain API operation for AWS Audit Manager. // -// Returns a list of all Audit Manager notifications. +// Lists the latest analytics data for controls within a specific control domain +// across all active assessments. +// +// Control insights are listed only if the control belongs to the control domain +// that was specified and the control collected evidence on the lastUpdated +// date of controlInsightsMetadata. If neither of these conditions are met, +// no data is listed for that control. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation ListNotifications for usage and error information. +// API operation ListControlInsightsByControlDomain for usage and error information. // // Returned Error Types: +// * ResourceNotFoundException +// The resource that's specified in the request can't be found. +// // * AccessDeniedException // Your account isn't registered with Audit Manager. Check the delegated administrator // setup on the Audit Manager settings page, and try again. // -// * ValidationException -// The request has invalid or missing parameters. -// // * InternalServerException // An internal service error occurred during the processing of your request. // Try again later. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListNotifications -func (c *AuditManager) ListNotifications(input *ListNotificationsInput) (*ListNotificationsOutput, error) { - req, out := c.ListNotificationsRequest(input) +// * ValidationException +// The request has invalid or missing parameters. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControlInsightsByControlDomain +func (c *AuditManager) ListControlInsightsByControlDomain(input *ListControlInsightsByControlDomainInput) (*ListControlInsightsByControlDomainOutput, error) { + req, out := c.ListControlInsightsByControlDomainRequest(input) return out, req.Send() } -// ListNotificationsWithContext is the same as ListNotifications with the addition of +// ListControlInsightsByControlDomainWithContext is the same as ListControlInsightsByControlDomain with the addition of // the ability to pass a context and additional request options. // -// See ListNotifications for details on how to use this API operation. +// See ListControlInsightsByControlDomain for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) ListNotificationsWithContext(ctx aws.Context, input *ListNotificationsInput, opts ...request.Option) (*ListNotificationsOutput, error) { - req, out := c.ListNotificationsRequest(input) +func (c *AuditManager) ListControlInsightsByControlDomainWithContext(ctx aws.Context, input *ListControlInsightsByControlDomainInput, opts ...request.Option) (*ListControlInsightsByControlDomainOutput, error) { + req, out := c.ListControlInsightsByControlDomainRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListNotificationsPages iterates over the pages of a ListNotifications operation, +// ListControlInsightsByControlDomainPages iterates over the pages of a ListControlInsightsByControlDomain operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListNotifications method for more information on how to use this operation. +// See ListControlInsightsByControlDomain method for more information on how to use this operation. // // Note: This operation can generate multiple requests to a service. // -// // Example iterating over at most 3 pages of a ListNotifications operation. +// // Example iterating over at most 3 pages of a ListControlInsightsByControlDomain operation. // pageNum := 0 -// err := client.ListNotificationsPages(params, -// func(page *auditmanager.ListNotificationsOutput, lastPage bool) bool { +// err := client.ListControlInsightsByControlDomainPages(params, +// func(page *auditmanager.ListControlInsightsByControlDomainOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) // -func (c *AuditManager) ListNotificationsPages(input *ListNotificationsInput, fn func(*ListNotificationsOutput, bool) bool) error { - return c.ListNotificationsPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *AuditManager) ListControlInsightsByControlDomainPages(input *ListControlInsightsByControlDomainInput, fn func(*ListControlInsightsByControlDomainOutput, bool) bool) error { + return c.ListControlInsightsByControlDomainPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListNotificationsPagesWithContext same as ListNotificationsPages except +// ListControlInsightsByControlDomainPagesWithContext same as ListControlInsightsByControlDomainPages except // it takes a Context and allows setting request options on the pages. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) ListNotificationsPagesWithContext(ctx aws.Context, input *ListNotificationsInput, fn func(*ListNotificationsOutput, bool) bool, opts ...request.Option) error { +func (c *AuditManager) ListControlInsightsByControlDomainPagesWithContext(ctx aws.Context, input *ListControlInsightsByControlDomainInput, fn func(*ListControlInsightsByControlDomainOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListNotificationsInput + var inCpy *ListControlInsightsByControlDomainInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListNotificationsRequest(inCpy) + req, _ := c.ListControlInsightsByControlDomainRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -4282,7 +4633,7 @@ func (c *AuditManager) ListNotificationsPagesWithContext(ctx aws.Context, input } for p.Next() { - if !fn(p.Page().(*ListNotificationsOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListControlInsightsByControlDomainOutput), !p.HasNextPage()) { break } } @@ -4290,607 +4641,776 @@ func (c *AuditManager) ListNotificationsPagesWithContext(ctx aws.Context, input return p.Err() } -const opListTagsForResource = "ListTagsForResource" +const opListControls = "ListControls" -// ListTagsForResourceRequest generates a "aws/request.Request" representing the -// client's request for the ListTagsForResource operation. The "output" return +// ListControlsRequest generates a "aws/request.Request" representing the +// client's request for the ListControls operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListTagsForResource for more information on using the ListTagsForResource +// See ListControls for more information on using the ListControls // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the ListTagsForResourceRequest method. -// req, resp := client.ListTagsForResourceRequest(params) +// // Example sending a request using the ListControlsRequest method. +// req, resp := client.ListControlsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListTagsForResource -func (c *AuditManager) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControls +func (c *AuditManager) ListControlsRequest(input *ListControlsInput) (req *request.Request, output *ListControlsOutput) { op := &request.Operation{ - Name: opListTagsForResource, + Name: opListControls, HTTPMethod: "GET", - HTTPPath: "/tags/{resourceArn}", + HTTPPath: "/controls", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, } if input == nil { - input = &ListTagsForResourceInput{} + input = &ListControlsInput{} } - output = &ListTagsForResourceOutput{} + output = &ListControlsOutput{} req = c.newRequest(op, input, output) return } -// ListTagsForResource API operation for AWS Audit Manager. +// ListControls API operation for AWS Audit Manager. // -// Returns a list of tags for the specified resource in Audit Manager. +// Returns a list of controls from Audit Manager. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation ListTagsForResource for usage and error information. +// API operation ListControls for usage and error information. // // Returned Error Types: -// * InternalServerException -// An internal service error occurred during the processing of your request. -// Try again later. +// * AccessDeniedException +// Your account isn't registered with Audit Manager. Check the delegated administrator +// setup on the Audit Manager settings page, and try again. // // * ValidationException // The request has invalid or missing parameters. // -// * ResourceNotFoundException -// The resource that's specified in the request can't be found. +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListTagsForResource -func (c *AuditManager) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { - req, out := c.ListTagsForResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListControls +func (c *AuditManager) ListControls(input *ListControlsInput) (*ListControlsOutput, error) { + req, out := c.ListControlsRequest(input) return out, req.Send() } -// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// ListControlsWithContext is the same as ListControls with the addition of // the ability to pass a context and additional request options. // -// See ListTagsForResource for details on how to use this API operation. +// See ListControls for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { - req, out := c.ListTagsForResourceRequest(input) +func (c *AuditManager) ListControlsWithContext(ctx aws.Context, input *ListControlsInput, opts ...request.Option) (*ListControlsOutput, error) { + req, out := c.ListControlsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opRegisterAccount = "RegisterAccount" +// ListControlsPages iterates over the pages of a ListControls operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListControls method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListControls operation. +// pageNum := 0 +// err := client.ListControlsPages(params, +// func(page *auditmanager.ListControlsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AuditManager) ListControlsPages(input *ListControlsInput, fn func(*ListControlsOutput, bool) bool) error { + return c.ListControlsPagesWithContext(aws.BackgroundContext(), input, fn) +} -// RegisterAccountRequest generates a "aws/request.Request" representing the -// client's request for the RegisterAccount operation. The "output" return +// ListControlsPagesWithContext same as ListControlsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListControlsPagesWithContext(ctx aws.Context, input *ListControlsInput, fn func(*ListControlsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListControlsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListControlsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListControlsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListKeywordsForDataSource = "ListKeywordsForDataSource" + +// ListKeywordsForDataSourceRequest generates a "aws/request.Request" representing the +// client's request for the ListKeywordsForDataSource operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See RegisterAccount for more information on using the RegisterAccount +// See ListKeywordsForDataSource for more information on using the ListKeywordsForDataSource // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the RegisterAccountRequest method. -// req, resp := client.RegisterAccountRequest(params) +// // Example sending a request using the ListKeywordsForDataSourceRequest method. +// req, resp := client.ListKeywordsForDataSourceRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/RegisterAccount -func (c *AuditManager) RegisterAccountRequest(input *RegisterAccountInput) (req *request.Request, output *RegisterAccountOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListKeywordsForDataSource +func (c *AuditManager) ListKeywordsForDataSourceRequest(input *ListKeywordsForDataSourceInput) (req *request.Request, output *ListKeywordsForDataSourceOutput) { op := &request.Operation{ - Name: opRegisterAccount, - HTTPMethod: "POST", - HTTPPath: "/account/registerAccount", - } - + Name: opListKeywordsForDataSource, + HTTPMethod: "GET", + HTTPPath: "/dataSourceKeywords", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + if input == nil { - input = &RegisterAccountInput{} + input = &ListKeywordsForDataSourceInput{} } - output = &RegisterAccountOutput{} + output = &ListKeywordsForDataSourceOutput{} req = c.newRequest(op, input, output) return } -// RegisterAccount API operation for AWS Audit Manager. +// ListKeywordsForDataSource API operation for AWS Audit Manager. // -// Enables Audit Manager for the specified Amazon Web Services account. +// Returns a list of keywords that are pre-mapped to the specified control data +// source. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation RegisterAccount for usage and error information. +// API operation ListKeywordsForDataSource for usage and error information. // // Returned Error Types: -// * ValidationException -// The request has invalid or missing parameters. -// // * AccessDeniedException // Your account isn't registered with Audit Manager. Check the delegated administrator // setup on the Audit Manager settings page, and try again. // +// * ValidationException +// The request has invalid or missing parameters. +// // * InternalServerException // An internal service error occurred during the processing of your request. // Try again later. // -// * ResourceNotFoundException -// The resource that's specified in the request can't be found. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/RegisterAccount -func (c *AuditManager) RegisterAccount(input *RegisterAccountInput) (*RegisterAccountOutput, error) { - req, out := c.RegisterAccountRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListKeywordsForDataSource +func (c *AuditManager) ListKeywordsForDataSource(input *ListKeywordsForDataSourceInput) (*ListKeywordsForDataSourceOutput, error) { + req, out := c.ListKeywordsForDataSourceRequest(input) return out, req.Send() } -// RegisterAccountWithContext is the same as RegisterAccount with the addition of +// ListKeywordsForDataSourceWithContext is the same as ListKeywordsForDataSource with the addition of // the ability to pass a context and additional request options. // -// See RegisterAccount for details on how to use this API operation. +// See ListKeywordsForDataSource for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) RegisterAccountWithContext(ctx aws.Context, input *RegisterAccountInput, opts ...request.Option) (*RegisterAccountOutput, error) { - req, out := c.RegisterAccountRequest(input) +func (c *AuditManager) ListKeywordsForDataSourceWithContext(ctx aws.Context, input *ListKeywordsForDataSourceInput, opts ...request.Option) (*ListKeywordsForDataSourceOutput, error) { + req, out := c.ListKeywordsForDataSourceRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opRegisterOrganizationAdminAccount = "RegisterOrganizationAdminAccount" +// ListKeywordsForDataSourcePages iterates over the pages of a ListKeywordsForDataSource operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListKeywordsForDataSource method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListKeywordsForDataSource operation. +// pageNum := 0 +// err := client.ListKeywordsForDataSourcePages(params, +// func(page *auditmanager.ListKeywordsForDataSourceOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AuditManager) ListKeywordsForDataSourcePages(input *ListKeywordsForDataSourceInput, fn func(*ListKeywordsForDataSourceOutput, bool) bool) error { + return c.ListKeywordsForDataSourcePagesWithContext(aws.BackgroundContext(), input, fn) +} -// RegisterOrganizationAdminAccountRequest generates a "aws/request.Request" representing the -// client's request for the RegisterOrganizationAdminAccount operation. The "output" return +// ListKeywordsForDataSourcePagesWithContext same as ListKeywordsForDataSourcePages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListKeywordsForDataSourcePagesWithContext(ctx aws.Context, input *ListKeywordsForDataSourceInput, fn func(*ListKeywordsForDataSourceOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListKeywordsForDataSourceInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListKeywordsForDataSourceRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListKeywordsForDataSourceOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListNotifications = "ListNotifications" + +// ListNotificationsRequest generates a "aws/request.Request" representing the +// client's request for the ListNotifications operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See RegisterOrganizationAdminAccount for more information on using the RegisterOrganizationAdminAccount +// See ListNotifications for more information on using the ListNotifications // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the RegisterOrganizationAdminAccountRequest method. -// req, resp := client.RegisterOrganizationAdminAccountRequest(params) +// // Example sending a request using the ListNotificationsRequest method. +// req, resp := client.ListNotificationsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/RegisterOrganizationAdminAccount -func (c *AuditManager) RegisterOrganizationAdminAccountRequest(input *RegisterOrganizationAdminAccountInput) (req *request.Request, output *RegisterOrganizationAdminAccountOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListNotifications +func (c *AuditManager) ListNotificationsRequest(input *ListNotificationsInput) (req *request.Request, output *ListNotificationsOutput) { op := &request.Operation{ - Name: opRegisterOrganizationAdminAccount, - HTTPMethod: "POST", - HTTPPath: "/account/registerOrganizationAdminAccount", + Name: opListNotifications, + HTTPMethod: "GET", + HTTPPath: "/notifications", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, } if input == nil { - input = &RegisterOrganizationAdminAccountInput{} + input = &ListNotificationsInput{} } - output = &RegisterOrganizationAdminAccountOutput{} + output = &ListNotificationsOutput{} req = c.newRequest(op, input, output) return } -// RegisterOrganizationAdminAccount API operation for AWS Audit Manager. +// ListNotifications API operation for AWS Audit Manager. // -// Enables an Amazon Web Services account within the organization as the delegated -// administrator for Audit Manager. +// Returns a list of all Audit Manager notifications. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation RegisterOrganizationAdminAccount for usage and error information. +// API operation ListNotifications for usage and error information. // // Returned Error Types: -// * ValidationException -// The request has invalid or missing parameters. -// // * AccessDeniedException // Your account isn't registered with Audit Manager. Check the delegated administrator // setup on the Audit Manager settings page, and try again. // +// * ValidationException +// The request has invalid or missing parameters. +// // * InternalServerException // An internal service error occurred during the processing of your request. // Try again later. // -// * ResourceNotFoundException -// The resource that's specified in the request can't be found. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/RegisterOrganizationAdminAccount -func (c *AuditManager) RegisterOrganizationAdminAccount(input *RegisterOrganizationAdminAccountInput) (*RegisterOrganizationAdminAccountOutput, error) { - req, out := c.RegisterOrganizationAdminAccountRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListNotifications +func (c *AuditManager) ListNotifications(input *ListNotificationsInput) (*ListNotificationsOutput, error) { + req, out := c.ListNotificationsRequest(input) return out, req.Send() } -// RegisterOrganizationAdminAccountWithContext is the same as RegisterOrganizationAdminAccount with the addition of +// ListNotificationsWithContext is the same as ListNotifications with the addition of // the ability to pass a context and additional request options. // -// See RegisterOrganizationAdminAccount for details on how to use this API operation. +// See ListNotifications for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) RegisterOrganizationAdminAccountWithContext(ctx aws.Context, input *RegisterOrganizationAdminAccountInput, opts ...request.Option) (*RegisterOrganizationAdminAccountOutput, error) { - req, out := c.RegisterOrganizationAdminAccountRequest(input) +func (c *AuditManager) ListNotificationsWithContext(ctx aws.Context, input *ListNotificationsInput, opts ...request.Option) (*ListNotificationsOutput, error) { + req, out := c.ListNotificationsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStartAssessmentFrameworkShare = "StartAssessmentFrameworkShare" +// ListNotificationsPages iterates over the pages of a ListNotifications operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListNotifications method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListNotifications operation. +// pageNum := 0 +// err := client.ListNotificationsPages(params, +// func(page *auditmanager.ListNotificationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *AuditManager) ListNotificationsPages(input *ListNotificationsInput, fn func(*ListNotificationsOutput, bool) bool) error { + return c.ListNotificationsPagesWithContext(aws.BackgroundContext(), input, fn) +} -// StartAssessmentFrameworkShareRequest generates a "aws/request.Request" representing the -// client's request for the StartAssessmentFrameworkShare operation. The "output" return +// ListNotificationsPagesWithContext same as ListNotificationsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ListNotificationsPagesWithContext(ctx aws.Context, input *ListNotificationsInput, fn func(*ListNotificationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListNotificationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListNotificationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListNotificationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See StartAssessmentFrameworkShare for more information on using the StartAssessmentFrameworkShare +// See ListTagsForResource for more information on using the ListTagsForResource // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the StartAssessmentFrameworkShareRequest method. -// req, resp := client.StartAssessmentFrameworkShareRequest(params) +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/StartAssessmentFrameworkShare -func (c *AuditManager) StartAssessmentFrameworkShareRequest(input *StartAssessmentFrameworkShareInput) (req *request.Request, output *StartAssessmentFrameworkShareOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListTagsForResource +func (c *AuditManager) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { op := &request.Operation{ - Name: opStartAssessmentFrameworkShare, - HTTPMethod: "POST", - HTTPPath: "/assessmentFrameworks/{frameworkId}/shareRequests", + Name: opListTagsForResource, + HTTPMethod: "GET", + HTTPPath: "/tags/{resourceArn}", } if input == nil { - input = &StartAssessmentFrameworkShareInput{} + input = &ListTagsForResourceInput{} } - output = &StartAssessmentFrameworkShareOutput{} + output = &ListTagsForResourceOutput{} req = c.newRequest(op, input, output) return } -// StartAssessmentFrameworkShare API operation for AWS Audit Manager. -// -// Creates a share request for a custom framework in Audit Manager. -// -// The share request specifies a recipient and notifies them that a custom framework -// is available. Recipients have 120 days to accept or decline the request. -// If no action is taken, the share request expires. +// ListTagsForResource API operation for AWS Audit Manager. // -// When you invoke the StartAssessmentFrameworkShare API, you are about to share -// a custom framework with another Amazon Web Services account. You may not -// share a custom framework that is derived from a standard framework if the -// standard framework is designated as not eligible for sharing by Amazon Web -// Services, unless you have obtained permission to do so from the owner of -// the standard framework. To learn more about which standard frameworks are -// eligible for sharing, see Framework sharing eligibility (https://docs.aws.amazon.com/audit-manager/latest/userguide/share-custom-framework-concepts-and-terminology.html#eligibility) -// in the Audit Manager User Guide. +// Returns a list of tags for the specified resource in Audit Manager. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation StartAssessmentFrameworkShare for usage and error information. +// API operation ListTagsForResource for usage and error information. // // Returned Error Types: -// * ValidationException -// The request has invalid or missing parameters. -// -// * AccessDeniedException -// Your account isn't registered with Audit Manager. Check the delegated administrator -// setup on the Audit Manager settings page, and try again. -// // * InternalServerException // An internal service error occurred during the processing of your request. // Try again later. // +// * ValidationException +// The request has invalid or missing parameters. +// // * ResourceNotFoundException // The resource that's specified in the request can't be found. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/StartAssessmentFrameworkShare -func (c *AuditManager) StartAssessmentFrameworkShare(input *StartAssessmentFrameworkShareInput) (*StartAssessmentFrameworkShareOutput, error) { - req, out := c.StartAssessmentFrameworkShareRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ListTagsForResource +func (c *AuditManager) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) return out, req.Send() } -// StartAssessmentFrameworkShareWithContext is the same as StartAssessmentFrameworkShare with the addition of +// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of // the ability to pass a context and additional request options. // -// See StartAssessmentFrameworkShare for details on how to use this API operation. +// See ListTagsForResource for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) StartAssessmentFrameworkShareWithContext(ctx aws.Context, input *StartAssessmentFrameworkShareInput, opts ...request.Option) (*StartAssessmentFrameworkShareOutput, error) { - req, out := c.StartAssessmentFrameworkShareRequest(input) +func (c *AuditManager) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opTagResource = "TagResource" +const opRegisterAccount = "RegisterAccount" -// TagResourceRequest generates a "aws/request.Request" representing the -// client's request for the TagResource operation. The "output" return +// RegisterAccountRequest generates a "aws/request.Request" representing the +// client's request for the RegisterAccount operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See TagResource for more information on using the TagResource +// See RegisterAccount for more information on using the RegisterAccount // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the TagResourceRequest method. -// req, resp := client.TagResourceRequest(params) +// // Example sending a request using the RegisterAccountRequest method. +// req, resp := client.RegisterAccountRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/TagResource -func (c *AuditManager) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/RegisterAccount +func (c *AuditManager) RegisterAccountRequest(input *RegisterAccountInput) (req *request.Request, output *RegisterAccountOutput) { op := &request.Operation{ - Name: opTagResource, + Name: opRegisterAccount, HTTPMethod: "POST", - HTTPPath: "/tags/{resourceArn}", + HTTPPath: "/account/registerAccount", } if input == nil { - input = &TagResourceInput{} + input = &RegisterAccountInput{} } - output = &TagResourceOutput{} + output = &RegisterAccountOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// TagResource API operation for AWS Audit Manager. +// RegisterAccount API operation for AWS Audit Manager. // -// Tags the specified resource in Audit Manager. +// Enables Audit Manager for the specified Amazon Web Services account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation TagResource for usage and error information. +// API operation RegisterAccount for usage and error information. // // Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// Your account isn't registered with Audit Manager. Check the delegated administrator +// setup on the Audit Manager settings page, and try again. +// // * InternalServerException // An internal service error occurred during the processing of your request. // Try again later. // -// * ValidationException -// The request has invalid or missing parameters. -// // * ResourceNotFoundException // The resource that's specified in the request can't be found. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/TagResource -func (c *AuditManager) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/RegisterAccount +func (c *AuditManager) RegisterAccount(input *RegisterAccountInput) (*RegisterAccountOutput, error) { + req, out := c.RegisterAccountRequest(input) return out, req.Send() } -// TagResourceWithContext is the same as TagResource with the addition of +// RegisterAccountWithContext is the same as RegisterAccount with the addition of // the ability to pass a context and additional request options. // -// See TagResource for details on how to use this API operation. +// See RegisterAccount for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) +func (c *AuditManager) RegisterAccountWithContext(ctx aws.Context, input *RegisterAccountInput, opts ...request.Option) (*RegisterAccountOutput, error) { + req, out := c.RegisterAccountRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUntagResource = "UntagResource" +const opRegisterOrganizationAdminAccount = "RegisterOrganizationAdminAccount" -// UntagResourceRequest generates a "aws/request.Request" representing the -// client's request for the UntagResource operation. The "output" return +// RegisterOrganizationAdminAccountRequest generates a "aws/request.Request" representing the +// client's request for the RegisterOrganizationAdminAccount operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UntagResource for more information on using the UntagResource +// See RegisterOrganizationAdminAccount for more information on using the RegisterOrganizationAdminAccount // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the UntagResourceRequest method. -// req, resp := client.UntagResourceRequest(params) +// // Example sending a request using the RegisterOrganizationAdminAccountRequest method. +// req, resp := client.RegisterOrganizationAdminAccountRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UntagResource -func (c *AuditManager) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/RegisterOrganizationAdminAccount +func (c *AuditManager) RegisterOrganizationAdminAccountRequest(input *RegisterOrganizationAdminAccountInput) (req *request.Request, output *RegisterOrganizationAdminAccountOutput) { op := &request.Operation{ - Name: opUntagResource, - HTTPMethod: "DELETE", - HTTPPath: "/tags/{resourceArn}", + Name: opRegisterOrganizationAdminAccount, + HTTPMethod: "POST", + HTTPPath: "/account/registerOrganizationAdminAccount", } if input == nil { - input = &UntagResourceInput{} + input = &RegisterOrganizationAdminAccountInput{} } - output = &UntagResourceOutput{} + output = &RegisterOrganizationAdminAccountOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UntagResource API operation for AWS Audit Manager. +// RegisterOrganizationAdminAccount API operation for AWS Audit Manager. // -// Removes a tag from a resource in Audit Manager. +// Enables an Amazon Web Services account within the organization as the delegated +// administrator for Audit Manager. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation UntagResource for usage and error information. +// API operation RegisterOrganizationAdminAccount for usage and error information. // // Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// Your account isn't registered with Audit Manager. Check the delegated administrator +// setup on the Audit Manager settings page, and try again. +// // * InternalServerException // An internal service error occurred during the processing of your request. // Try again later. // -// * ValidationException -// The request has invalid or missing parameters. -// // * ResourceNotFoundException // The resource that's specified in the request can't be found. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UntagResource -func (c *AuditManager) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/RegisterOrganizationAdminAccount +func (c *AuditManager) RegisterOrganizationAdminAccount(input *RegisterOrganizationAdminAccountInput) (*RegisterOrganizationAdminAccountOutput, error) { + req, out := c.RegisterOrganizationAdminAccountRequest(input) return out, req.Send() } -// UntagResourceWithContext is the same as UntagResource with the addition of +// RegisterOrganizationAdminAccountWithContext is the same as RegisterOrganizationAdminAccount with the addition of // the ability to pass a context and additional request options. // -// See UntagResource for details on how to use this API operation. +// See RegisterOrganizationAdminAccount for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) +func (c *AuditManager) RegisterOrganizationAdminAccountWithContext(ctx aws.Context, input *RegisterOrganizationAdminAccountInput, opts ...request.Option) (*RegisterOrganizationAdminAccountOutput, error) { + req, out := c.RegisterOrganizationAdminAccountRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateAssessment = "UpdateAssessment" +const opStartAssessmentFrameworkShare = "StartAssessmentFrameworkShare" -// UpdateAssessmentRequest generates a "aws/request.Request" representing the -// client's request for the UpdateAssessment operation. The "output" return +// StartAssessmentFrameworkShareRequest generates a "aws/request.Request" representing the +// client's request for the StartAssessmentFrameworkShare operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateAssessment for more information on using the UpdateAssessment +// See StartAssessmentFrameworkShare for more information on using the StartAssessmentFrameworkShare // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the UpdateAssessmentRequest method. -// req, resp := client.UpdateAssessmentRequest(params) +// // Example sending a request using the StartAssessmentFrameworkShareRequest method. +// req, resp := client.StartAssessmentFrameworkShareRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessment -func (c *AuditManager) UpdateAssessmentRequest(input *UpdateAssessmentInput) (req *request.Request, output *UpdateAssessmentOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/StartAssessmentFrameworkShare +func (c *AuditManager) StartAssessmentFrameworkShareRequest(input *StartAssessmentFrameworkShareInput) (req *request.Request, output *StartAssessmentFrameworkShareOutput) { op := &request.Operation{ - Name: opUpdateAssessment, - HTTPMethod: "PUT", - HTTPPath: "/assessments/{assessmentId}", + Name: opStartAssessmentFrameworkShare, + HTTPMethod: "POST", + HTTPPath: "/assessmentFrameworks/{frameworkId}/shareRequests", } if input == nil { - input = &UpdateAssessmentInput{} + input = &StartAssessmentFrameworkShareInput{} } - output = &UpdateAssessmentOutput{} + output = &StartAssessmentFrameworkShareOutput{} req = c.newRequest(op, input, output) return } -// UpdateAssessment API operation for AWS Audit Manager. +// StartAssessmentFrameworkShare API operation for AWS Audit Manager. // -// Edits an Audit Manager assessment. +// Creates a share request for a custom framework in Audit Manager. +// +// The share request specifies a recipient and notifies them that a custom framework +// is available. Recipients have 120 days to accept or decline the request. +// If no action is taken, the share request expires. +// +// When you invoke the StartAssessmentFrameworkShare API, you are about to share +// a custom framework with another Amazon Web Services account. You may not +// share a custom framework that is derived from a standard framework if the +// standard framework is designated as not eligible for sharing by Amazon Web +// Services, unless you have obtained permission to do so from the owner of +// the standard framework. To learn more about which standard frameworks are +// eligible for sharing, see Framework sharing eligibility (https://docs.aws.amazon.com/audit-manager/latest/userguide/share-custom-framework-concepts-and-terminology.html#eligibility) +// in the Audit Manager User Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation UpdateAssessment for usage and error information. +// API operation StartAssessmentFrameworkShare for usage and error information. // // Returned Error Types: -// * ResourceNotFoundException -// The resource that's specified in the request can't be found. -// // * ValidationException // The request has invalid or missing parameters. // @@ -4902,260 +5422,257 @@ func (c *AuditManager) UpdateAssessmentRequest(input *UpdateAssessmentInput) (re // An internal service error occurred during the processing of your request. // Try again later. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessment -func (c *AuditManager) UpdateAssessment(input *UpdateAssessmentInput) (*UpdateAssessmentOutput, error) { - req, out := c.UpdateAssessmentRequest(input) +// * ResourceNotFoundException +// The resource that's specified in the request can't be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/StartAssessmentFrameworkShare +func (c *AuditManager) StartAssessmentFrameworkShare(input *StartAssessmentFrameworkShareInput) (*StartAssessmentFrameworkShareOutput, error) { + req, out := c.StartAssessmentFrameworkShareRequest(input) return out, req.Send() } -// UpdateAssessmentWithContext is the same as UpdateAssessment with the addition of +// StartAssessmentFrameworkShareWithContext is the same as StartAssessmentFrameworkShare with the addition of // the ability to pass a context and additional request options. // -// See UpdateAssessment for details on how to use this API operation. +// See StartAssessmentFrameworkShare for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) UpdateAssessmentWithContext(ctx aws.Context, input *UpdateAssessmentInput, opts ...request.Option) (*UpdateAssessmentOutput, error) { - req, out := c.UpdateAssessmentRequest(input) +func (c *AuditManager) StartAssessmentFrameworkShareWithContext(ctx aws.Context, input *StartAssessmentFrameworkShareInput, opts ...request.Option) (*StartAssessmentFrameworkShareOutput, error) { + req, out := c.StartAssessmentFrameworkShareRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateAssessmentControl = "UpdateAssessmentControl" +const opTagResource = "TagResource" -// UpdateAssessmentControlRequest generates a "aws/request.Request" representing the -// client's request for the UpdateAssessmentControl operation. The "output" return +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateAssessmentControl for more information on using the UpdateAssessmentControl +// See TagResource for more information on using the TagResource // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the UpdateAssessmentControlRequest method. -// req, resp := client.UpdateAssessmentControlRequest(params) +// // Example sending a request using the TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentControl -func (c *AuditManager) UpdateAssessmentControlRequest(input *UpdateAssessmentControlInput) (req *request.Request, output *UpdateAssessmentControlOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/TagResource +func (c *AuditManager) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { op := &request.Operation{ - Name: opUpdateAssessmentControl, - HTTPMethod: "PUT", - HTTPPath: "/assessments/{assessmentId}/controlSets/{controlSetId}/controls/{controlId}", + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/tags/{resourceArn}", } if input == nil { - input = &UpdateAssessmentControlInput{} + input = &TagResourceInput{} } - output = &UpdateAssessmentControlOutput{} + output = &TagResourceOutput{} req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateAssessmentControl API operation for AWS Audit Manager. +// TagResource API operation for AWS Audit Manager. // -// Updates a control within an assessment in Audit Manager. +// Tags the specified resource in Audit Manager. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation UpdateAssessmentControl for usage and error information. +// API operation TagResource for usage and error information. // // Returned Error Types: -// * ResourceNotFoundException -// The resource that's specified in the request can't be found. +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. // // * ValidationException // The request has invalid or missing parameters. // -// * AccessDeniedException -// Your account isn't registered with Audit Manager. Check the delegated administrator -// setup on the Audit Manager settings page, and try again. -// -// * InternalServerException -// An internal service error occurred during the processing of your request. -// Try again later. +// * ResourceNotFoundException +// The resource that's specified in the request can't be found. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentControl -func (c *AuditManager) UpdateAssessmentControl(input *UpdateAssessmentControlInput) (*UpdateAssessmentControlOutput, error) { - req, out := c.UpdateAssessmentControlRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/TagResource +func (c *AuditManager) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) return out, req.Send() } -// UpdateAssessmentControlWithContext is the same as UpdateAssessmentControl with the addition of +// TagResourceWithContext is the same as TagResource with the addition of // the ability to pass a context and additional request options. // -// See UpdateAssessmentControl for details on how to use this API operation. +// See TagResource for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) UpdateAssessmentControlWithContext(ctx aws.Context, input *UpdateAssessmentControlInput, opts ...request.Option) (*UpdateAssessmentControlOutput, error) { - req, out := c.UpdateAssessmentControlRequest(input) +func (c *AuditManager) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateAssessmentControlSetStatus = "UpdateAssessmentControlSetStatus" +const opUntagResource = "UntagResource" -// UpdateAssessmentControlSetStatusRequest generates a "aws/request.Request" representing the -// client's request for the UpdateAssessmentControlSetStatus operation. The "output" return +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateAssessmentControlSetStatus for more information on using the UpdateAssessmentControlSetStatus +// See UntagResource for more information on using the UntagResource // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the UpdateAssessmentControlSetStatusRequest method. -// req, resp := client.UpdateAssessmentControlSetStatusRequest(params) +// // Example sending a request using the UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus -func (c *AuditManager) UpdateAssessmentControlSetStatusRequest(input *UpdateAssessmentControlSetStatusInput) (req *request.Request, output *UpdateAssessmentControlSetStatusOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UntagResource +func (c *AuditManager) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { op := &request.Operation{ - Name: opUpdateAssessmentControlSetStatus, - HTTPMethod: "PUT", - HTTPPath: "/assessments/{assessmentId}/controlSets/{controlSetId}/status", + Name: opUntagResource, + HTTPMethod: "DELETE", + HTTPPath: "/tags/{resourceArn}", } if input == nil { - input = &UpdateAssessmentControlSetStatusInput{} + input = &UntagResourceInput{} } - output = &UpdateAssessmentControlSetStatusOutput{} + output = &UntagResourceOutput{} req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateAssessmentControlSetStatus API operation for AWS Audit Manager. +// UntagResource API operation for AWS Audit Manager. // -// Updates the status of a control set in an Audit Manager assessment. +// Removes a tag from a resource in Audit Manager. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation UpdateAssessmentControlSetStatus for usage and error information. +// API operation UntagResource for usage and error information. // // Returned Error Types: -// * ResourceNotFoundException -// The resource that's specified in the request can't be found. +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. // // * ValidationException // The request has invalid or missing parameters. // -// * AccessDeniedException -// Your account isn't registered with Audit Manager. Check the delegated administrator -// setup on the Audit Manager settings page, and try again. -// -// * InternalServerException -// An internal service error occurred during the processing of your request. -// Try again later. +// * ResourceNotFoundException +// The resource that's specified in the request can't be found. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus -func (c *AuditManager) UpdateAssessmentControlSetStatus(input *UpdateAssessmentControlSetStatusInput) (*UpdateAssessmentControlSetStatusOutput, error) { - req, out := c.UpdateAssessmentControlSetStatusRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UntagResource +func (c *AuditManager) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) return out, req.Send() } -// UpdateAssessmentControlSetStatusWithContext is the same as UpdateAssessmentControlSetStatus with the addition of +// UntagResourceWithContext is the same as UntagResource with the addition of // the ability to pass a context and additional request options. // -// See UpdateAssessmentControlSetStatus for details on how to use this API operation. +// See UntagResource for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) UpdateAssessmentControlSetStatusWithContext(ctx aws.Context, input *UpdateAssessmentControlSetStatusInput, opts ...request.Option) (*UpdateAssessmentControlSetStatusOutput, error) { - req, out := c.UpdateAssessmentControlSetStatusRequest(input) +func (c *AuditManager) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateAssessmentFramework = "UpdateAssessmentFramework" +const opUpdateAssessment = "UpdateAssessment" -// UpdateAssessmentFrameworkRequest generates a "aws/request.Request" representing the -// client's request for the UpdateAssessmentFramework operation. The "output" return +// UpdateAssessmentRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAssessment operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateAssessmentFramework for more information on using the UpdateAssessmentFramework +// See UpdateAssessment for more information on using the UpdateAssessment // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the UpdateAssessmentFrameworkRequest method. -// req, resp := client.UpdateAssessmentFrameworkRequest(params) +// // Example sending a request using the UpdateAssessmentRequest method. +// req, resp := client.UpdateAssessmentRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentFramework -func (c *AuditManager) UpdateAssessmentFrameworkRequest(input *UpdateAssessmentFrameworkInput) (req *request.Request, output *UpdateAssessmentFrameworkOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessment +func (c *AuditManager) UpdateAssessmentRequest(input *UpdateAssessmentInput) (req *request.Request, output *UpdateAssessmentOutput) { op := &request.Operation{ - Name: opUpdateAssessmentFramework, + Name: opUpdateAssessment, HTTPMethod: "PUT", - HTTPPath: "/assessmentFrameworks/{frameworkId}", + HTTPPath: "/assessments/{assessmentId}", } if input == nil { - input = &UpdateAssessmentFrameworkInput{} + input = &UpdateAssessmentInput{} } - output = &UpdateAssessmentFrameworkOutput{} + output = &UpdateAssessmentOutput{} req = c.newRequest(op, input, output) return } -// UpdateAssessmentFramework API operation for AWS Audit Manager. +// UpdateAssessment API operation for AWS Audit Manager. // -// Updates a custom framework in Audit Manager. +// Edits an Audit Manager assessment. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation UpdateAssessmentFramework for usage and error information. +// API operation UpdateAssessment for usage and error information. // // Returned Error Types: // * ResourceNotFoundException @@ -5172,80 +5689,80 @@ func (c *AuditManager) UpdateAssessmentFrameworkRequest(input *UpdateAssessmentF // An internal service error occurred during the processing of your request. // Try again later. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentFramework -func (c *AuditManager) UpdateAssessmentFramework(input *UpdateAssessmentFrameworkInput) (*UpdateAssessmentFrameworkOutput, error) { - req, out := c.UpdateAssessmentFrameworkRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessment +func (c *AuditManager) UpdateAssessment(input *UpdateAssessmentInput) (*UpdateAssessmentOutput, error) { + req, out := c.UpdateAssessmentRequest(input) return out, req.Send() } -// UpdateAssessmentFrameworkWithContext is the same as UpdateAssessmentFramework with the addition of +// UpdateAssessmentWithContext is the same as UpdateAssessment with the addition of // the ability to pass a context and additional request options. // -// See UpdateAssessmentFramework for details on how to use this API operation. +// See UpdateAssessment for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) UpdateAssessmentFrameworkWithContext(ctx aws.Context, input *UpdateAssessmentFrameworkInput, opts ...request.Option) (*UpdateAssessmentFrameworkOutput, error) { - req, out := c.UpdateAssessmentFrameworkRequest(input) +func (c *AuditManager) UpdateAssessmentWithContext(ctx aws.Context, input *UpdateAssessmentInput, opts ...request.Option) (*UpdateAssessmentOutput, error) { + req, out := c.UpdateAssessmentRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateAssessmentFrameworkShare = "UpdateAssessmentFrameworkShare" +const opUpdateAssessmentControl = "UpdateAssessmentControl" -// UpdateAssessmentFrameworkShareRequest generates a "aws/request.Request" representing the -// client's request for the UpdateAssessmentFrameworkShare operation. The "output" return +// UpdateAssessmentControlRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAssessmentControl operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateAssessmentFrameworkShare for more information on using the UpdateAssessmentFrameworkShare +// See UpdateAssessmentControl for more information on using the UpdateAssessmentControl // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the UpdateAssessmentFrameworkShareRequest method. -// req, resp := client.UpdateAssessmentFrameworkShareRequest(params) +// // Example sending a request using the UpdateAssessmentControlRequest method. +// req, resp := client.UpdateAssessmentControlRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare -func (c *AuditManager) UpdateAssessmentFrameworkShareRequest(input *UpdateAssessmentFrameworkShareInput) (req *request.Request, output *UpdateAssessmentFrameworkShareOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentControl +func (c *AuditManager) UpdateAssessmentControlRequest(input *UpdateAssessmentControlInput) (req *request.Request, output *UpdateAssessmentControlOutput) { op := &request.Operation{ - Name: opUpdateAssessmentFrameworkShare, + Name: opUpdateAssessmentControl, HTTPMethod: "PUT", - HTTPPath: "/assessmentFrameworkShareRequests/{requestId}", + HTTPPath: "/assessments/{assessmentId}/controlSets/{controlSetId}/controls/{controlId}", } if input == nil { - input = &UpdateAssessmentFrameworkShareInput{} + input = &UpdateAssessmentControlInput{} } - output = &UpdateAssessmentFrameworkShareOutput{} + output = &UpdateAssessmentControlOutput{} req = c.newRequest(op, input, output) return } -// UpdateAssessmentFrameworkShare API operation for AWS Audit Manager. +// UpdateAssessmentControl API operation for AWS Audit Manager. // -// Updates a share request for a custom framework in Audit Manager. +// Updates a control within an assessment in Audit Manager. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation UpdateAssessmentFrameworkShare for usage and error information. +// API operation UpdateAssessmentControl for usage and error information. // // Returned Error Types: // * ResourceNotFoundException @@ -5262,80 +5779,80 @@ func (c *AuditManager) UpdateAssessmentFrameworkShareRequest(input *UpdateAssess // An internal service error occurred during the processing of your request. // Try again later. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare -func (c *AuditManager) UpdateAssessmentFrameworkShare(input *UpdateAssessmentFrameworkShareInput) (*UpdateAssessmentFrameworkShareOutput, error) { - req, out := c.UpdateAssessmentFrameworkShareRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentControl +func (c *AuditManager) UpdateAssessmentControl(input *UpdateAssessmentControlInput) (*UpdateAssessmentControlOutput, error) { + req, out := c.UpdateAssessmentControlRequest(input) return out, req.Send() } -// UpdateAssessmentFrameworkShareWithContext is the same as UpdateAssessmentFrameworkShare with the addition of +// UpdateAssessmentControlWithContext is the same as UpdateAssessmentControl with the addition of // the ability to pass a context and additional request options. // -// See UpdateAssessmentFrameworkShare for details on how to use this API operation. +// See UpdateAssessmentControl for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) UpdateAssessmentFrameworkShareWithContext(ctx aws.Context, input *UpdateAssessmentFrameworkShareInput, opts ...request.Option) (*UpdateAssessmentFrameworkShareOutput, error) { - req, out := c.UpdateAssessmentFrameworkShareRequest(input) +func (c *AuditManager) UpdateAssessmentControlWithContext(ctx aws.Context, input *UpdateAssessmentControlInput, opts ...request.Option) (*UpdateAssessmentControlOutput, error) { + req, out := c.UpdateAssessmentControlRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateAssessmentStatus = "UpdateAssessmentStatus" +const opUpdateAssessmentControlSetStatus = "UpdateAssessmentControlSetStatus" -// UpdateAssessmentStatusRequest generates a "aws/request.Request" representing the -// client's request for the UpdateAssessmentStatus operation. The "output" return +// UpdateAssessmentControlSetStatusRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAssessmentControlSetStatus operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateAssessmentStatus for more information on using the UpdateAssessmentStatus +// See UpdateAssessmentControlSetStatus for more information on using the UpdateAssessmentControlSetStatus // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the UpdateAssessmentStatusRequest method. -// req, resp := client.UpdateAssessmentStatusRequest(params) +// // Example sending a request using the UpdateAssessmentControlSetStatusRequest method. +// req, resp := client.UpdateAssessmentControlSetStatusRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentStatus -func (c *AuditManager) UpdateAssessmentStatusRequest(input *UpdateAssessmentStatusInput) (req *request.Request, output *UpdateAssessmentStatusOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus +func (c *AuditManager) UpdateAssessmentControlSetStatusRequest(input *UpdateAssessmentControlSetStatusInput) (req *request.Request, output *UpdateAssessmentControlSetStatusOutput) { op := &request.Operation{ - Name: opUpdateAssessmentStatus, + Name: opUpdateAssessmentControlSetStatus, HTTPMethod: "PUT", - HTTPPath: "/assessments/{assessmentId}/status", + HTTPPath: "/assessments/{assessmentId}/controlSets/{controlSetId}/status", } if input == nil { - input = &UpdateAssessmentStatusInput{} + input = &UpdateAssessmentControlSetStatusInput{} } - output = &UpdateAssessmentStatusOutput{} + output = &UpdateAssessmentControlSetStatusOutput{} req = c.newRequest(op, input, output) return } -// UpdateAssessmentStatus API operation for AWS Audit Manager. +// UpdateAssessmentControlSetStatus API operation for AWS Audit Manager. // -// Updates the status of an assessment in Audit Manager. +// Updates the status of a control set in an Audit Manager assessment. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation UpdateAssessmentStatus for usage and error information. +// API operation UpdateAssessmentControlSetStatus for usage and error information. // // Returned Error Types: // * ResourceNotFoundException @@ -5352,80 +5869,80 @@ func (c *AuditManager) UpdateAssessmentStatusRequest(input *UpdateAssessmentStat // An internal service error occurred during the processing of your request. // Try again later. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentStatus -func (c *AuditManager) UpdateAssessmentStatus(input *UpdateAssessmentStatusInput) (*UpdateAssessmentStatusOutput, error) { - req, out := c.UpdateAssessmentStatusRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentControlSetStatus +func (c *AuditManager) UpdateAssessmentControlSetStatus(input *UpdateAssessmentControlSetStatusInput) (*UpdateAssessmentControlSetStatusOutput, error) { + req, out := c.UpdateAssessmentControlSetStatusRequest(input) return out, req.Send() } -// UpdateAssessmentStatusWithContext is the same as UpdateAssessmentStatus with the addition of +// UpdateAssessmentControlSetStatusWithContext is the same as UpdateAssessmentControlSetStatus with the addition of // the ability to pass a context and additional request options. // -// See UpdateAssessmentStatus for details on how to use this API operation. +// See UpdateAssessmentControlSetStatus for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) UpdateAssessmentStatusWithContext(ctx aws.Context, input *UpdateAssessmentStatusInput, opts ...request.Option) (*UpdateAssessmentStatusOutput, error) { - req, out := c.UpdateAssessmentStatusRequest(input) +func (c *AuditManager) UpdateAssessmentControlSetStatusWithContext(ctx aws.Context, input *UpdateAssessmentControlSetStatusInput, opts ...request.Option) (*UpdateAssessmentControlSetStatusOutput, error) { + req, out := c.UpdateAssessmentControlSetStatusRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateControl = "UpdateControl" +const opUpdateAssessmentFramework = "UpdateAssessmentFramework" -// UpdateControlRequest generates a "aws/request.Request" representing the -// client's request for the UpdateControl operation. The "output" return +// UpdateAssessmentFrameworkRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAssessmentFramework operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateControl for more information on using the UpdateControl +// See UpdateAssessmentFramework for more information on using the UpdateAssessmentFramework // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the UpdateControlRequest method. -// req, resp := client.UpdateControlRequest(params) +// // Example sending a request using the UpdateAssessmentFrameworkRequest method. +// req, resp := client.UpdateAssessmentFrameworkRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateControl -func (c *AuditManager) UpdateControlRequest(input *UpdateControlInput) (req *request.Request, output *UpdateControlOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentFramework +func (c *AuditManager) UpdateAssessmentFrameworkRequest(input *UpdateAssessmentFrameworkInput) (req *request.Request, output *UpdateAssessmentFrameworkOutput) { op := &request.Operation{ - Name: opUpdateControl, + Name: opUpdateAssessmentFramework, HTTPMethod: "PUT", - HTTPPath: "/controls/{controlId}", + HTTPPath: "/assessmentFrameworks/{frameworkId}", } if input == nil { - input = &UpdateControlInput{} + input = &UpdateAssessmentFrameworkInput{} } - output = &UpdateControlOutput{} + output = &UpdateAssessmentFrameworkOutput{} req = c.newRequest(op, input, output) return } -// UpdateControl API operation for AWS Audit Manager. +// UpdateAssessmentFramework API operation for AWS Audit Manager. // -// Updates a custom control in Audit Manager. +// Updates a custom framework in Audit Manager. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation UpdateControl for usage and error information. +// API operation UpdateAssessmentFramework for usage and error information. // // Returned Error Types: // * ResourceNotFoundException @@ -5442,82 +5959,85 @@ func (c *AuditManager) UpdateControlRequest(input *UpdateControlInput) (req *req // An internal service error occurred during the processing of your request. // Try again later. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateControl -func (c *AuditManager) UpdateControl(input *UpdateControlInput) (*UpdateControlOutput, error) { - req, out := c.UpdateControlRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentFramework +func (c *AuditManager) UpdateAssessmentFramework(input *UpdateAssessmentFrameworkInput) (*UpdateAssessmentFrameworkOutput, error) { + req, out := c.UpdateAssessmentFrameworkRequest(input) return out, req.Send() } -// UpdateControlWithContext is the same as UpdateControl with the addition of +// UpdateAssessmentFrameworkWithContext is the same as UpdateAssessmentFramework with the addition of // the ability to pass a context and additional request options. // -// See UpdateControl for details on how to use this API operation. +// See UpdateAssessmentFramework for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) UpdateControlWithContext(ctx aws.Context, input *UpdateControlInput, opts ...request.Option) (*UpdateControlOutput, error) { - req, out := c.UpdateControlRequest(input) +func (c *AuditManager) UpdateAssessmentFrameworkWithContext(ctx aws.Context, input *UpdateAssessmentFrameworkInput, opts ...request.Option) (*UpdateAssessmentFrameworkOutput, error) { + req, out := c.UpdateAssessmentFrameworkRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateSettings = "UpdateSettings" +const opUpdateAssessmentFrameworkShare = "UpdateAssessmentFrameworkShare" -// UpdateSettingsRequest generates a "aws/request.Request" representing the -// client's request for the UpdateSettings operation. The "output" return +// UpdateAssessmentFrameworkShareRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAssessmentFrameworkShare operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See UpdateSettings for more information on using the UpdateSettings +// See UpdateAssessmentFrameworkShare for more information on using the UpdateAssessmentFrameworkShare // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the UpdateSettingsRequest method. -// req, resp := client.UpdateSettingsRequest(params) +// // Example sending a request using the UpdateAssessmentFrameworkShareRequest method. +// req, resp := client.UpdateAssessmentFrameworkShareRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateSettings -func (c *AuditManager) UpdateSettingsRequest(input *UpdateSettingsInput) (req *request.Request, output *UpdateSettingsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare +func (c *AuditManager) UpdateAssessmentFrameworkShareRequest(input *UpdateAssessmentFrameworkShareInput) (req *request.Request, output *UpdateAssessmentFrameworkShareOutput) { op := &request.Operation{ - Name: opUpdateSettings, + Name: opUpdateAssessmentFrameworkShare, HTTPMethod: "PUT", - HTTPPath: "/settings", + HTTPPath: "/assessmentFrameworkShareRequests/{requestId}", } if input == nil { - input = &UpdateSettingsInput{} + input = &UpdateAssessmentFrameworkShareInput{} } - output = &UpdateSettingsOutput{} + output = &UpdateAssessmentFrameworkShareOutput{} req = c.newRequest(op, input, output) return } -// UpdateSettings API operation for AWS Audit Manager. +// UpdateAssessmentFrameworkShare API operation for AWS Audit Manager. // -// Updates Audit Manager settings for the current user account. +// Updates a share request for a custom framework in Audit Manager. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation UpdateSettings for usage and error information. +// API operation UpdateAssessmentFrameworkShare for usage and error information. // // Returned Error Types: +// * ResourceNotFoundException +// The resource that's specified in the request can't be found. +// // * ValidationException // The request has invalid or missing parameters. // @@ -5529,82 +6049,85 @@ func (c *AuditManager) UpdateSettingsRequest(input *UpdateSettingsInput) (req *r // An internal service error occurred during the processing of your request. // Try again later. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateSettings -func (c *AuditManager) UpdateSettings(input *UpdateSettingsInput) (*UpdateSettingsOutput, error) { - req, out := c.UpdateSettingsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentFrameworkShare +func (c *AuditManager) UpdateAssessmentFrameworkShare(input *UpdateAssessmentFrameworkShareInput) (*UpdateAssessmentFrameworkShareOutput, error) { + req, out := c.UpdateAssessmentFrameworkShareRequest(input) return out, req.Send() } -// UpdateSettingsWithContext is the same as UpdateSettings with the addition of +// UpdateAssessmentFrameworkShareWithContext is the same as UpdateAssessmentFrameworkShare with the addition of // the ability to pass a context and additional request options. // -// See UpdateSettings for details on how to use this API operation. +// See UpdateAssessmentFrameworkShare for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) UpdateSettingsWithContext(ctx aws.Context, input *UpdateSettingsInput, opts ...request.Option) (*UpdateSettingsOutput, error) { - req, out := c.UpdateSettingsRequest(input) +func (c *AuditManager) UpdateAssessmentFrameworkShareWithContext(ctx aws.Context, input *UpdateAssessmentFrameworkShareInput, opts ...request.Option) (*UpdateAssessmentFrameworkShareOutput, error) { + req, out := c.UpdateAssessmentFrameworkShareRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opValidateAssessmentReportIntegrity = "ValidateAssessmentReportIntegrity" +const opUpdateAssessmentStatus = "UpdateAssessmentStatus" -// ValidateAssessmentReportIntegrityRequest generates a "aws/request.Request" representing the -// client's request for the ValidateAssessmentReportIntegrity operation. The "output" return +// UpdateAssessmentStatusRequest generates a "aws/request.Request" representing the +// client's request for the UpdateAssessmentStatus operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ValidateAssessmentReportIntegrity for more information on using the ValidateAssessmentReportIntegrity +// See UpdateAssessmentStatus for more information on using the UpdateAssessmentStatus // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the ValidateAssessmentReportIntegrityRequest method. -// req, resp := client.ValidateAssessmentReportIntegrityRequest(params) +// // Example sending a request using the UpdateAssessmentStatusRequest method. +// req, resp := client.UpdateAssessmentStatusRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity -func (c *AuditManager) ValidateAssessmentReportIntegrityRequest(input *ValidateAssessmentReportIntegrityInput) (req *request.Request, output *ValidateAssessmentReportIntegrityOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentStatus +func (c *AuditManager) UpdateAssessmentStatusRequest(input *UpdateAssessmentStatusInput) (req *request.Request, output *UpdateAssessmentStatusOutput) { op := &request.Operation{ - Name: opValidateAssessmentReportIntegrity, - HTTPMethod: "POST", - HTTPPath: "/assessmentReports/integrity", + Name: opUpdateAssessmentStatus, + HTTPMethod: "PUT", + HTTPPath: "/assessments/{assessmentId}/status", } if input == nil { - input = &ValidateAssessmentReportIntegrityInput{} + input = &UpdateAssessmentStatusInput{} } - output = &ValidateAssessmentReportIntegrityOutput{} + output = &UpdateAssessmentStatusOutput{} req = c.newRequest(op, input, output) return } -// ValidateAssessmentReportIntegrity API operation for AWS Audit Manager. +// UpdateAssessmentStatus API operation for AWS Audit Manager. // -// Validates the integrity of an assessment report in Audit Manager. +// Updates the status of an assessment in Audit Manager. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Audit Manager's -// API operation ValidateAssessmentReportIntegrity for usage and error information. +// API operation UpdateAssessmentStatus for usage and error information. // // Returned Error Types: +// * ResourceNotFoundException +// The resource that's specified in the request can't be found. +// // * ValidationException // The request has invalid or missing parameters. // @@ -5616,102 +6139,366 @@ func (c *AuditManager) ValidateAssessmentReportIntegrityRequest(input *ValidateA // An internal service error occurred during the processing of your request. // Try again later. // -// * ResourceNotFoundException -// The resource that's specified in the request can't be found. -// -// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity -func (c *AuditManager) ValidateAssessmentReportIntegrity(input *ValidateAssessmentReportIntegrityInput) (*ValidateAssessmentReportIntegrityOutput, error) { - req, out := c.ValidateAssessmentReportIntegrityRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateAssessmentStatus +func (c *AuditManager) UpdateAssessmentStatus(input *UpdateAssessmentStatusInput) (*UpdateAssessmentStatusOutput, error) { + req, out := c.UpdateAssessmentStatusRequest(input) return out, req.Send() } -// ValidateAssessmentReportIntegrityWithContext is the same as ValidateAssessmentReportIntegrity with the addition of +// UpdateAssessmentStatusWithContext is the same as UpdateAssessmentStatus with the addition of // the ability to pass a context and additional request options. // -// See ValidateAssessmentReportIntegrity for details on how to use this API operation. +// See UpdateAssessmentStatus for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *AuditManager) ValidateAssessmentReportIntegrityWithContext(ctx aws.Context, input *ValidateAssessmentReportIntegrityInput, opts ...request.Option) (*ValidateAssessmentReportIntegrityOutput, error) { - req, out := c.ValidateAssessmentReportIntegrityRequest(input) +func (c *AuditManager) UpdateAssessmentStatusWithContext(ctx aws.Context, input *UpdateAssessmentStatusInput, opts ...request.Option) (*UpdateAssessmentStatusOutput, error) { + req, out := c.UpdateAssessmentStatusRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// The wrapper of Amazon Web Services account details, such as account ID or -// email address. -type AWSAccount struct { - _ struct{} `type:"structure"` +const opUpdateControl = "UpdateControl" - // The email address that's associated with the Amazon Web Services account. - EmailAddress *string `locationName:"emailAddress" min:"1" type:"string"` +// UpdateControlRequest generates a "aws/request.Request" representing the +// client's request for the UpdateControl operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateControl for more information on using the UpdateControl +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateControlRequest method. +// req, resp := client.UpdateControlRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateControl +func (c *AuditManager) UpdateControlRequest(input *UpdateControlInput) (req *request.Request, output *UpdateControlOutput) { + op := &request.Operation{ + Name: opUpdateControl, + HTTPMethod: "PUT", + HTTPPath: "/controls/{controlId}", + } - // The identifier for the Amazon Web Services account. - Id *string `locationName:"id" min:"12" type:"string"` + if input == nil { + input = &UpdateControlInput{} + } - // The name of the Amazon Web Services account. - Name *string `locationName:"name" min:"1" type:"string"` + output = &UpdateControlOutput{} + req = c.newRequest(op, input, output) + return } -// String returns the string representation. +// UpdateControl API operation for AWS Audit Manager. // -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s AWSAccount) String() string { - return awsutil.Prettify(s) +// Updates a custom control in Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation UpdateControl for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The resource that's specified in the request can't be found. +// +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// Your account isn't registered with Audit Manager. Check the delegated administrator +// setup on the Audit Manager settings page, and try again. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateControl +func (c *AuditManager) UpdateControl(input *UpdateControlInput) (*UpdateControlOutput, error) { + req, out := c.UpdateControlRequest(input) + return out, req.Send() } -// GoString returns the string representation. +// UpdateControlWithContext is the same as UpdateControl with the addition of +// the ability to pass a context and additional request options. // -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s AWSAccount) GoString() string { - return s.String() +// See UpdateControl for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) UpdateControlWithContext(ctx aws.Context, input *UpdateControlInput, opts ...request.Option) (*UpdateControlOutput, error) { + req, out := c.UpdateControlRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *AWSAccount) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "AWSAccount"} - if s.EmailAddress != nil && len(*s.EmailAddress) < 1 { - invalidParams.Add(request.NewErrParamMinLen("EmailAddress", 1)) - } - if s.Id != nil && len(*s.Id) < 12 { - invalidParams.Add(request.NewErrParamMinLen("Id", 12)) - } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) - } +const opUpdateSettings = "UpdateSettings" - if invalidParams.Len() > 0 { - return invalidParams +// UpdateSettingsRequest generates a "aws/request.Request" representing the +// client's request for the UpdateSettings operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateSettings for more information on using the UpdateSettings +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateSettingsRequest method. +// req, resp := client.UpdateSettingsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateSettings +func (c *AuditManager) UpdateSettingsRequest(input *UpdateSettingsInput) (req *request.Request, output *UpdateSettingsOutput) { + op := &request.Operation{ + Name: opUpdateSettings, + HTTPMethod: "PUT", + HTTPPath: "/settings", } - return nil -} - -// SetEmailAddress sets the EmailAddress field's value. -func (s *AWSAccount) SetEmailAddress(v string) *AWSAccount { - s.EmailAddress = &v - return s -} -// SetId sets the Id field's value. -func (s *AWSAccount) SetId(v string) *AWSAccount { - s.Id = &v - return s -} + if input == nil { + input = &UpdateSettingsInput{} + } -// SetName sets the Name field's value. -func (s *AWSAccount) SetName(v string) *AWSAccount { - s.Name = &v - return s + output = &UpdateSettingsOutput{} + req = c.newRequest(op, input, output) + return } -// An Amazon Web Service such as Amazon S3 or CloudTrail. +// UpdateSettings API operation for AWS Audit Manager. +// +// Updates Audit Manager settings for the current user account. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation UpdateSettings for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// Your account isn't registered with Audit Manager. Check the delegated administrator +// setup on the Audit Manager settings page, and try again. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/UpdateSettings +func (c *AuditManager) UpdateSettings(input *UpdateSettingsInput) (*UpdateSettingsOutput, error) { + req, out := c.UpdateSettingsRequest(input) + return out, req.Send() +} + +// UpdateSettingsWithContext is the same as UpdateSettings with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateSettings for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) UpdateSettingsWithContext(ctx aws.Context, input *UpdateSettingsInput, opts ...request.Option) (*UpdateSettingsOutput, error) { + req, out := c.UpdateSettingsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opValidateAssessmentReportIntegrity = "ValidateAssessmentReportIntegrity" + +// ValidateAssessmentReportIntegrityRequest generates a "aws/request.Request" representing the +// client's request for the ValidateAssessmentReportIntegrity operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ValidateAssessmentReportIntegrity for more information on using the ValidateAssessmentReportIntegrity +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ValidateAssessmentReportIntegrityRequest method. +// req, resp := client.ValidateAssessmentReportIntegrityRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity +func (c *AuditManager) ValidateAssessmentReportIntegrityRequest(input *ValidateAssessmentReportIntegrityInput) (req *request.Request, output *ValidateAssessmentReportIntegrityOutput) { + op := &request.Operation{ + Name: opValidateAssessmentReportIntegrity, + HTTPMethod: "POST", + HTTPPath: "/assessmentReports/integrity", + } + + if input == nil { + input = &ValidateAssessmentReportIntegrityInput{} + } + + output = &ValidateAssessmentReportIntegrityOutput{} + req = c.newRequest(op, input, output) + return +} + +// ValidateAssessmentReportIntegrity API operation for AWS Audit Manager. +// +// Validates the integrity of an assessment report in Audit Manager. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Audit Manager's +// API operation ValidateAssessmentReportIntegrity for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request has invalid or missing parameters. +// +// * AccessDeniedException +// Your account isn't registered with Audit Manager. Check the delegated administrator +// setup on the Audit Manager settings page, and try again. +// +// * InternalServerException +// An internal service error occurred during the processing of your request. +// Try again later. +// +// * ResourceNotFoundException +// The resource that's specified in the request can't be found. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/auditmanager-2017-07-25/ValidateAssessmentReportIntegrity +func (c *AuditManager) ValidateAssessmentReportIntegrity(input *ValidateAssessmentReportIntegrityInput) (*ValidateAssessmentReportIntegrityOutput, error) { + req, out := c.ValidateAssessmentReportIntegrityRequest(input) + return out, req.Send() +} + +// ValidateAssessmentReportIntegrityWithContext is the same as ValidateAssessmentReportIntegrity with the addition of +// the ability to pass a context and additional request options. +// +// See ValidateAssessmentReportIntegrity for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *AuditManager) ValidateAssessmentReportIntegrityWithContext(ctx aws.Context, input *ValidateAssessmentReportIntegrityInput, opts ...request.Option) (*ValidateAssessmentReportIntegrityOutput, error) { + req, out := c.ValidateAssessmentReportIntegrityRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// The wrapper of Amazon Web Services account details, such as account ID or +// email address. +type AWSAccount struct { + _ struct{} `type:"structure"` + + // The email address that's associated with the Amazon Web Services account. + EmailAddress *string `locationName:"emailAddress" min:"1" type:"string"` + + // The identifier for the Amazon Web Services account. + Id *string `locationName:"id" min:"12" type:"string"` + + // The name of the Amazon Web Services account. + Name *string `locationName:"name" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AWSAccount) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AWSAccount) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AWSAccount) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AWSAccount"} + if s.EmailAddress != nil && len(*s.EmailAddress) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EmailAddress", 1)) + } + if s.Id != nil && len(*s.Id) < 12 { + invalidParams.Add(request.NewErrParamMinLen("Id", 12)) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEmailAddress sets the EmailAddress field's value. +func (s *AWSAccount) SetEmailAddress(v string) *AWSAccount { + s.EmailAddress = &v + return s +} + +// SetId sets the Id field's value. +func (s *AWSAccount) SetId(v string) *AWSAccount { + s.Id = &v + return s +} + +// SetName sets the Name field's value. +func (s *AWSAccount) SetName(v string) *AWSAccount { + s.Name = &v + return s +} + +// An Amazon Web Service such as Amazon S3 or CloudTrail. type AWSService struct { _ struct{} `type:"structure"` @@ -8269,36 +9056,32 @@ func (s *ControlComment) SetPostedDate(v time.Time) *ControlComment { return s } -// The data source that determines where Audit Manager collects evidence from -// for the control. -type ControlMappingSource struct { +// A summary of the latest analytics data for a specific control domain. +// +// Control domain insights are grouped by control domain, and ranked by the +// highest total count of non-compliant evidence. +type ControlDomainInsights struct { _ struct{} `type:"structure"` - // The description of the source. - SourceDescription *string `locationName:"sourceDescription" type:"string"` - - // The frequency of evidence collection for the control mapping source. - SourceFrequency *string `locationName:"sourceFrequency" type:"string" enum:"SourceFrequency"` - - // The unique identifier for the source. - SourceId *string `locationName:"sourceId" min:"36" type:"string"` + // The number of controls in the control domain that collected non-compliant + // evidence on the lastUpdated date. + ControlsCountByNoncompliantEvidence *int64 `locationName:"controlsCountByNoncompliantEvidence" type:"integer"` - // The keyword to search for in CloudTrail logs, Config rules, Security Hub - // checks, and Amazon Web Services API names. - SourceKeyword *SourceKeyword `locationName:"sourceKeyword" type:"structure"` + // A breakdown of the compliance check status for the evidence that’s associated + // with the control domain. + EvidenceInsights *EvidenceInsights `locationName:"evidenceInsights" type:"structure"` - // The name of the source. - SourceName *string `locationName:"sourceName" min:"1" type:"string"` + // The unique identifier for the control domain. + Id *string `locationName:"id" min:"36" type:"string"` - // The setup option for the data source. This option reflects if the evidence - // collection is automated or manual. - SourceSetUpOption *string `locationName:"sourceSetUpOption" type:"string" enum:"SourceSetUpOption"` + // The time when the control domain insights were last updated. + LastUpdated *time.Time `locationName:"lastUpdated" type:"timestamp"` - // Specifies one of the five types of data sources for evidence collection. - SourceType *string `locationName:"sourceType" type:"string" enum:"SourceType"` + // The name of the control domain. + Name *string `locationName:"name" min:"1" type:"string"` - // The instructions for troubleshooting the control. - TroubleshootingText *string `locationName:"troubleshootingText" type:"string"` + // The total number of controls in the control domain. + TotalControlsCount *int64 `locationName:"totalControlsCount" type:"integer"` } // String returns the string representation. @@ -8306,7 +9089,7 @@ type ControlMappingSource struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ControlMappingSource) String() string { +func (s ControlDomainInsights) String() string { return awsutil.Prettify(s) } @@ -8315,29 +9098,252 @@ func (s ControlMappingSource) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ControlMappingSource) GoString() string { +func (s ControlDomainInsights) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *ControlMappingSource) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ControlMappingSource"} - if s.SourceId != nil && len(*s.SourceId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("SourceId", 36)) - } - if s.SourceName != nil && len(*s.SourceName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("SourceName", 1)) - } - if s.SourceKeyword != nil { - if err := s.SourceKeyword.Validate(); err != nil { - invalidParams.AddNested("SourceKeyword", err.(request.ErrInvalidParams)) - } - } +// SetControlsCountByNoncompliantEvidence sets the ControlsCountByNoncompliantEvidence field's value. +func (s *ControlDomainInsights) SetControlsCountByNoncompliantEvidence(v int64) *ControlDomainInsights { + s.ControlsCountByNoncompliantEvidence = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetEvidenceInsights sets the EvidenceInsights field's value. +func (s *ControlDomainInsights) SetEvidenceInsights(v *EvidenceInsights) *ControlDomainInsights { + s.EvidenceInsights = v + return s +} + +// SetId sets the Id field's value. +func (s *ControlDomainInsights) SetId(v string) *ControlDomainInsights { + s.Id = &v + return s +} + +// SetLastUpdated sets the LastUpdated field's value. +func (s *ControlDomainInsights) SetLastUpdated(v time.Time) *ControlDomainInsights { + s.LastUpdated = &v + return s +} + +// SetName sets the Name field's value. +func (s *ControlDomainInsights) SetName(v string) *ControlDomainInsights { + s.Name = &v + return s +} + +// SetTotalControlsCount sets the TotalControlsCount field's value. +func (s *ControlDomainInsights) SetTotalControlsCount(v int64) *ControlDomainInsights { + s.TotalControlsCount = &v + return s +} + +// A summary of the latest analytics data for a specific control in a specific +// active assessment. +// +// Control insights are grouped by control domain, and ranked by the highest +// total count of non-compliant evidence. +type ControlInsightsMetadataByAssessmentItem struct { + _ struct{} `type:"structure"` + + // The name of the control set that the assessment control belongs to. + ControlSetName *string `locationName:"controlSetName" min:"1" type:"string"` + + // A breakdown of the compliance check status for the evidence that’s associated + // with the assessment control. + EvidenceInsights *EvidenceInsights `locationName:"evidenceInsights" type:"structure"` + + // The unique identifier for the assessment control. + Id *string `locationName:"id" min:"36" type:"string"` + + // The time when the assessment control insights were last updated. + LastUpdated *time.Time `locationName:"lastUpdated" type:"timestamp"` + + // The name of the assessment control. + Name *string `locationName:"name" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ControlInsightsMetadataByAssessmentItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ControlInsightsMetadataByAssessmentItem) GoString() string { + return s.String() +} + +// SetControlSetName sets the ControlSetName field's value. +func (s *ControlInsightsMetadataByAssessmentItem) SetControlSetName(v string) *ControlInsightsMetadataByAssessmentItem { + s.ControlSetName = &v + return s +} + +// SetEvidenceInsights sets the EvidenceInsights field's value. +func (s *ControlInsightsMetadataByAssessmentItem) SetEvidenceInsights(v *EvidenceInsights) *ControlInsightsMetadataByAssessmentItem { + s.EvidenceInsights = v + return s +} + +// SetId sets the Id field's value. +func (s *ControlInsightsMetadataByAssessmentItem) SetId(v string) *ControlInsightsMetadataByAssessmentItem { + s.Id = &v + return s +} + +// SetLastUpdated sets the LastUpdated field's value. +func (s *ControlInsightsMetadataByAssessmentItem) SetLastUpdated(v time.Time) *ControlInsightsMetadataByAssessmentItem { + s.LastUpdated = &v + return s +} + +// SetName sets the Name field's value. +func (s *ControlInsightsMetadataByAssessmentItem) SetName(v string) *ControlInsightsMetadataByAssessmentItem { + s.Name = &v + return s +} + +// A summary of the latest analytics data for a specific control. +// +// This data reflects the total counts for the specified control across all +// active assessments. Control insights are grouped by control domain, and ranked +// by the highest total count of non-compliant evidence. +type ControlInsightsMetadataItem struct { + _ struct{} `type:"structure"` + + // A breakdown of the compliance check status for the evidence that’s associated + // with the control. + EvidenceInsights *EvidenceInsights `locationName:"evidenceInsights" type:"structure"` + + // The unique identifier for the control. + Id *string `locationName:"id" min:"36" type:"string"` + + // The time when the control insights were last updated. + LastUpdated *time.Time `locationName:"lastUpdated" type:"timestamp"` + + // The name of the control. + Name *string `locationName:"name" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ControlInsightsMetadataItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ControlInsightsMetadataItem) GoString() string { + return s.String() +} + +// SetEvidenceInsights sets the EvidenceInsights field's value. +func (s *ControlInsightsMetadataItem) SetEvidenceInsights(v *EvidenceInsights) *ControlInsightsMetadataItem { + s.EvidenceInsights = v + return s +} + +// SetId sets the Id field's value. +func (s *ControlInsightsMetadataItem) SetId(v string) *ControlInsightsMetadataItem { + s.Id = &v + return s +} + +// SetLastUpdated sets the LastUpdated field's value. +func (s *ControlInsightsMetadataItem) SetLastUpdated(v time.Time) *ControlInsightsMetadataItem { + s.LastUpdated = &v + return s +} + +// SetName sets the Name field's value. +func (s *ControlInsightsMetadataItem) SetName(v string) *ControlInsightsMetadataItem { + s.Name = &v + return s +} + +// The data source that determines where Audit Manager collects evidence from +// for the control. +type ControlMappingSource struct { + _ struct{} `type:"structure"` + + // The description of the source. + SourceDescription *string `locationName:"sourceDescription" type:"string"` + + // The frequency of evidence collection for the control mapping source. + SourceFrequency *string `locationName:"sourceFrequency" type:"string" enum:"SourceFrequency"` + + // The unique identifier for the source. + SourceId *string `locationName:"sourceId" min:"36" type:"string"` + + // The keyword to search for in CloudTrail logs, Config rules, Security Hub + // checks, and Amazon Web Services API names. + SourceKeyword *SourceKeyword `locationName:"sourceKeyword" type:"structure"` + + // The name of the source. + SourceName *string `locationName:"sourceName" min:"1" type:"string"` + + // The setup option for the data source. This option reflects if the evidence + // collection is automated or manual. + SourceSetUpOption *string `locationName:"sourceSetUpOption" type:"string" enum:"SourceSetUpOption"` + + // Specifies one of the five types of data sources for evidence collection. + SourceType *string `locationName:"sourceType" type:"string" enum:"SourceType"` + + // The instructions for troubleshooting the control. + TroubleshootingText *string `locationName:"troubleshootingText" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ControlMappingSource) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ControlMappingSource) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ControlMappingSource) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ControlMappingSource"} + if s.SourceId != nil && len(*s.SourceId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("SourceId", 36)) + } + if s.SourceName != nil && len(*s.SourceName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SourceName", 1)) + } + if s.SourceKeyword != nil { + if err := s.SourceKeyword.Validate(); err != nil { + invalidParams.AddNested("SourceKeyword", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } // SetSourceDescription sets the SourceDescription field's value. @@ -9620,7 +10626,7 @@ func (s *DelegationMetadata) SetStatus(v string) *DelegationMetadata { type DeleteAssessmentFrameworkInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier for the framework. + // The identifier for the custom framework. // // FrameworkId is a required field FrameworkId *string `location:"uri" locationName:"frameworkId" min:"36" type:"string" required:"true"` @@ -9847,7 +10853,7 @@ func (s DeleteAssessmentOutput) GoString() string { type DeleteAssessmentReportInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier for the assessment. + // The unique identifier for the assessment. // // AssessmentId is a required field AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` @@ -9935,7 +10941,7 @@ func (s DeleteAssessmentReportOutput) GoString() string { type DeleteControlInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier for the control. + // The unique identifier for the control. // // ControlId is a required field ControlId *string `location:"uri" locationName:"controlId" min:"36" type:"string" required:"true"` @@ -10125,12 +11131,12 @@ func (s DeregisterOrganizationAdminAccountOutput) GoString() string { type DisassociateAssessmentReportEvidenceFolderInput struct { _ struct{} `type:"structure"` - // The identifier for the assessment. + // The unique identifier for the assessment. // // AssessmentId is a required field AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` - // The identifier for the folder in which evidence is stored. + // The unique identifier for the folder that the evidence is stored in. // // EvidenceFolderId is a required field EvidenceFolderId *string `locationName:"evidenceFolderId" min:"36" type:"string" required:"true"` @@ -10377,6 +11383,68 @@ func (s *Evidence) SetTime(v time.Time) *Evidence { return s } +// A breakdown of the latest compliance check status for the evidence in your +// Audit Manager assessments. +type EvidenceInsights struct { + _ struct{} `type:"structure"` + + // The number of compliance check evidence that Audit Manager classified as + // compliant. This includes evidence that was collected from Security Hub with + // a Pass ruling, or collected from Config with a Compliant ruling. + CompliantEvidenceCount *int64 `locationName:"compliantEvidenceCount" type:"integer"` + + // The number of evidence that a compliance check ruling isn't available for. + // Evidence is inconclusive when the associated control uses Security Hub or + // Config as a data source but you didn't enable those services. This is also + // the case when a control uses a data source that doesn’t support compliance + // checks (for example, manual evidence, API calls, or CloudTrail). + // + // If evidence has a compliance check status of not applicable in the console, + // it's classified as inconclusive in EvidenceInsights data. + InconclusiveEvidenceCount *int64 `locationName:"inconclusiveEvidenceCount" type:"integer"` + + // The number of compliance check evidence that Audit Manager classified as + // non-compliant. This includes evidence that was collected from Security Hub + // with a Fail ruling, or collected from Config with a Non-compliant ruling. + NoncompliantEvidenceCount *int64 `locationName:"noncompliantEvidenceCount" type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EvidenceInsights) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EvidenceInsights) GoString() string { + return s.String() +} + +// SetCompliantEvidenceCount sets the CompliantEvidenceCount field's value. +func (s *EvidenceInsights) SetCompliantEvidenceCount(v int64) *EvidenceInsights { + s.CompliantEvidenceCount = &v + return s +} + +// SetInconclusiveEvidenceCount sets the InconclusiveEvidenceCount field's value. +func (s *EvidenceInsights) SetInconclusiveEvidenceCount(v int64) *EvidenceInsights { + s.InconclusiveEvidenceCount = &v + return s +} + +// SetNoncompliantEvidenceCount sets the NoncompliantEvidenceCount field's value. +func (s *EvidenceInsights) SetNoncompliantEvidenceCount(v int64) *EvidenceInsights { + s.NoncompliantEvidenceCount = &v + return s +} + // The file that's used to structure and automate Audit Manager assessments // for a given compliance standard. type Framework struct { @@ -10522,28 +11590,500 @@ func (s *Framework) SetTags(v map[string]*string) *Framework { return s } -// SetType sets the Type field's value. -func (s *Framework) SetType(v string) *Framework { - s.Type = &v +// SetType sets the Type field's value. +func (s *Framework) SetType(v string) *Framework { + s.Type = &v + return s +} + +// The metadata of a framework, such as the name, ID, or description. +type FrameworkMetadata struct { + _ struct{} `type:"structure"` + + // The compliance standard that's associated with the framework. For example, + // this could be PCI DSS or HIPAA. + ComplianceType *string `locationName:"complianceType" type:"string"` + + // The description of the framework. + Description *string `locationName:"description" min:"1" type:"string"` + + // The logo that's associated with the framework. + Logo *string `locationName:"logo" min:"1" type:"string"` + + // The name of the framework. + Name *string `locationName:"name" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FrameworkMetadata) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FrameworkMetadata) GoString() string { + return s.String() +} + +// SetComplianceType sets the ComplianceType field's value. +func (s *FrameworkMetadata) SetComplianceType(v string) *FrameworkMetadata { + s.ComplianceType = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *FrameworkMetadata) SetDescription(v string) *FrameworkMetadata { + s.Description = &v + return s +} + +// SetLogo sets the Logo field's value. +func (s *FrameworkMetadata) SetLogo(v string) *FrameworkMetadata { + s.Logo = &v + return s +} + +// SetName sets the Name field's value. +func (s *FrameworkMetadata) SetName(v string) *FrameworkMetadata { + s.Name = &v + return s +} + +type GetAccountStatusInput struct { + _ struct{} `type:"structure" nopayload:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAccountStatusInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAccountStatusInput) GoString() string { + return s.String() +} + +type GetAccountStatusOutput struct { + _ struct{} `type:"structure"` + + // The status of the Amazon Web Services account. + Status *string `locationName:"status" type:"string" enum:"AccountStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAccountStatusOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAccountStatusOutput) GoString() string { + return s.String() +} + +// SetStatus sets the Status field's value. +func (s *GetAccountStatusOutput) SetStatus(v string) *GetAccountStatusOutput { + s.Status = &v + return s +} + +type GetAssessmentFrameworkInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The identifier for the framework. + // + // FrameworkId is a required field + FrameworkId *string `location:"uri" locationName:"frameworkId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAssessmentFrameworkInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAssessmentFrameworkInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetAssessmentFrameworkInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetAssessmentFrameworkInput"} + if s.FrameworkId == nil { + invalidParams.Add(request.NewErrParamRequired("FrameworkId")) + } + if s.FrameworkId != nil && len(*s.FrameworkId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("FrameworkId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFrameworkId sets the FrameworkId field's value. +func (s *GetAssessmentFrameworkInput) SetFrameworkId(v string) *GetAssessmentFrameworkInput { + s.FrameworkId = &v + return s +} + +type GetAssessmentFrameworkOutput struct { + _ struct{} `type:"structure"` + + // The framework that the GetAssessmentFramework API returned. + Framework *Framework `locationName:"framework" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAssessmentFrameworkOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAssessmentFrameworkOutput) GoString() string { + return s.String() +} + +// SetFramework sets the Framework field's value. +func (s *GetAssessmentFrameworkOutput) SetFramework(v *Framework) *GetAssessmentFrameworkOutput { + s.Framework = v + return s +} + +type GetAssessmentInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The unique identifier for the assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAssessmentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAssessmentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetAssessmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetAssessmentInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *GetAssessmentInput) SetAssessmentId(v string) *GetAssessmentInput { + s.AssessmentId = &v + return s +} + +type GetAssessmentOutput struct { + _ struct{} `type:"structure"` + + // An entity that defines the scope of audit evidence collected by Audit Manager. + // An Audit Manager assessment is an implementation of an Audit Manager framework. + Assessment *Assessment `locationName:"assessment" type:"structure"` + + // The wrapper that contains the Audit Manager role information of the current + // user. This includes the role type and IAM Amazon Resource Name (ARN). + UserRole *Role `locationName:"userRole" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAssessmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAssessmentOutput) GoString() string { + return s.String() +} + +// SetAssessment sets the Assessment field's value. +func (s *GetAssessmentOutput) SetAssessment(v *Assessment) *GetAssessmentOutput { + s.Assessment = v + return s +} + +// SetUserRole sets the UserRole field's value. +func (s *GetAssessmentOutput) SetUserRole(v *Role) *GetAssessmentOutput { + s.UserRole = v + return s +} + +type GetAssessmentReportUrlInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The unique identifier for the assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The unique identifier for the assessment report. + // + // AssessmentReportId is a required field + AssessmentReportId *string `location:"uri" locationName:"assessmentReportId" min:"36" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAssessmentReportUrlInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAssessmentReportUrlInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetAssessmentReportUrlInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetAssessmentReportUrlInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.AssessmentReportId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentReportId")) + } + if s.AssessmentReportId != nil && len(*s.AssessmentReportId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentReportId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *GetAssessmentReportUrlInput) SetAssessmentId(v string) *GetAssessmentReportUrlInput { + s.AssessmentId = &v + return s +} + +// SetAssessmentReportId sets the AssessmentReportId field's value. +func (s *GetAssessmentReportUrlInput) SetAssessmentReportId(v string) *GetAssessmentReportUrlInput { + s.AssessmentReportId = &v + return s +} + +type GetAssessmentReportUrlOutput struct { + _ struct{} `type:"structure"` + + // Short for uniform resource locator. A URL is used as a unique identifier + // to locate a resource on the internet. + PreSignedUrl *URL `locationName:"preSignedUrl" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAssessmentReportUrlOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetAssessmentReportUrlOutput) GoString() string { + return s.String() +} + +// SetPreSignedUrl sets the PreSignedUrl field's value. +func (s *GetAssessmentReportUrlOutput) SetPreSignedUrl(v *URL) *GetAssessmentReportUrlOutput { + s.PreSignedUrl = v + return s +} + +type GetChangeLogsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The unique identifier for the assessment. + // + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The unique identifier for the control. + ControlId *string `location:"querystring" locationName:"controlId" min:"36" type:"string"` + + // The unique identifier for the control set. + ControlSetId *string `location:"querystring" locationName:"controlSetId" min:"1" type:"string"` + + // Represents the maximum number of results on a page or for an API request + // call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token that's used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetChangeLogsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetChangeLogsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetChangeLogsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetChangeLogsInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } + if s.ControlId != nil && len(*s.ControlId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ControlId", 36)) + } + if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssessmentId sets the AssessmentId field's value. +func (s *GetChangeLogsInput) SetAssessmentId(v string) *GetChangeLogsInput { + s.AssessmentId = &v + return s +} + +// SetControlId sets the ControlId field's value. +func (s *GetChangeLogsInput) SetControlId(v string) *GetChangeLogsInput { + s.ControlId = &v + return s +} + +// SetControlSetId sets the ControlSetId field's value. +func (s *GetChangeLogsInput) SetControlSetId(v string) *GetChangeLogsInput { + s.ControlSetId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *GetChangeLogsInput) SetMaxResults(v int64) *GetChangeLogsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetChangeLogsInput) SetNextToken(v string) *GetChangeLogsInput { + s.NextToken = &v return s } -// The metadata of a framework, such as the name, ID, or description. -type FrameworkMetadata struct { +type GetChangeLogsOutput struct { _ struct{} `type:"structure"` - // The compliance standard that's associated with the framework. For example, - // this could be PCI DSS or HIPAA. - ComplianceType *string `locationName:"complianceType" type:"string"` - - // The description of the framework. - Description *string `locationName:"description" min:"1" type:"string"` - - // The logo that's associated with the framework. - Logo *string `locationName:"logo" min:"1" type:"string"` + // The list of user activity for the control. + ChangeLogs []*ChangeLog `locationName:"changeLogs" type:"list"` - // The name of the framework. - Name *string `locationName:"name" min:"1" type:"string"` + // The pagination token that's used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation. @@ -10551,7 +12091,7 @@ type FrameworkMetadata struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s FrameworkMetadata) String() string { +func (s GetChangeLogsOutput) String() string { return awsutil.Prettify(s) } @@ -10560,36 +12100,29 @@ func (s FrameworkMetadata) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s FrameworkMetadata) GoString() string { +func (s GetChangeLogsOutput) GoString() string { return s.String() } -// SetComplianceType sets the ComplianceType field's value. -func (s *FrameworkMetadata) SetComplianceType(v string) *FrameworkMetadata { - s.ComplianceType = &v - return s -} - -// SetDescription sets the Description field's value. -func (s *FrameworkMetadata) SetDescription(v string) *FrameworkMetadata { - s.Description = &v - return s -} - -// SetLogo sets the Logo field's value. -func (s *FrameworkMetadata) SetLogo(v string) *FrameworkMetadata { - s.Logo = &v +// SetChangeLogs sets the ChangeLogs field's value. +func (s *GetChangeLogsOutput) SetChangeLogs(v []*ChangeLog) *GetChangeLogsOutput { + s.ChangeLogs = v return s } -// SetName sets the Name field's value. -func (s *FrameworkMetadata) SetName(v string) *FrameworkMetadata { - s.Name = &v +// SetNextToken sets the NextToken field's value. +func (s *GetChangeLogsOutput) SetNextToken(v string) *GetChangeLogsOutput { + s.NextToken = &v return s } -type GetAccountStatusInput struct { +type GetControlInput struct { _ struct{} `type:"structure" nopayload:"true"` + + // The identifier for the control. + // + // ControlId is a required field + ControlId *string `location:"uri" locationName:"controlId" min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -10597,7 +12130,7 @@ type GetAccountStatusInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAccountStatusInput) String() string { +func (s GetControlInput) String() string { return awsutil.Prettify(s) } @@ -10606,15 +12139,37 @@ func (s GetAccountStatusInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAccountStatusInput) GoString() string { +func (s GetControlInput) GoString() string { return s.String() } -type GetAccountStatusOutput struct { +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetControlInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetControlInput"} + if s.ControlId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlId")) + } + if s.ControlId != nil && len(*s.ControlId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ControlId", 36)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetControlId sets the ControlId field's value. +func (s *GetControlInput) SetControlId(v string) *GetControlInput { + s.ControlId = &v + return s +} + +type GetControlOutput struct { _ struct{} `type:"structure"` - // The status of the Amazon Web Services account. - Status *string `locationName:"status" type:"string" enum:"AccountStatus"` + // The name of the control that the GetControl API returned. + Control *Control `locationName:"control" type:"structure"` } // String returns the string representation. @@ -10622,7 +12177,7 @@ type GetAccountStatusOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAccountStatusOutput) String() string { +func (s GetControlOutput) String() string { return awsutil.Prettify(s) } @@ -10631,23 +12186,25 @@ func (s GetAccountStatusOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAccountStatusOutput) GoString() string { +func (s GetControlOutput) GoString() string { return s.String() } -// SetStatus sets the Status field's value. -func (s *GetAccountStatusOutput) SetStatus(v string) *GetAccountStatusOutput { - s.Status = &v +// SetControl sets the Control field's value. +func (s *GetControlOutput) SetControl(v *Control) *GetControlOutput { + s.Control = v return s } -type GetAssessmentFrameworkInput struct { +type GetDelegationsInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier for the framework. - // - // FrameworkId is a required field - FrameworkId *string `location:"uri" locationName:"frameworkId" min:"36" type:"string" required:"true"` + // Represents the maximum number of results on a page or for an API request + // call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token that's used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation. @@ -10655,7 +12212,7 @@ type GetAssessmentFrameworkInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAssessmentFrameworkInput) String() string { +func (s GetDelegationsInput) String() string { return awsutil.Prettify(s) } @@ -10664,18 +12221,18 @@ func (s GetAssessmentFrameworkInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAssessmentFrameworkInput) GoString() string { +func (s GetDelegationsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetAssessmentFrameworkInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetAssessmentFrameworkInput"} - if s.FrameworkId == nil { - invalidParams.Add(request.NewErrParamRequired("FrameworkId")) +func (s *GetDelegationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetDelegationsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } - if s.FrameworkId != nil && len(*s.FrameworkId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("FrameworkId", 36)) + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } if invalidParams.Len() > 0 { @@ -10684,17 +12241,26 @@ func (s *GetAssessmentFrameworkInput) Validate() error { return nil } -// SetFrameworkId sets the FrameworkId field's value. -func (s *GetAssessmentFrameworkInput) SetFrameworkId(v string) *GetAssessmentFrameworkInput { - s.FrameworkId = &v +// SetMaxResults sets the MaxResults field's value. +func (s *GetDelegationsInput) SetMaxResults(v int64) *GetDelegationsInput { + s.MaxResults = &v return s } -type GetAssessmentFrameworkOutput struct { +// SetNextToken sets the NextToken field's value. +func (s *GetDelegationsInput) SetNextToken(v string) *GetDelegationsInput { + s.NextToken = &v + return s +} + +type GetDelegationsOutput struct { _ struct{} `type:"structure"` - // The framework that the GetAssessmentFramework API returned. - Framework *Framework `locationName:"framework" type:"structure"` + // The list of delegations that the GetDelegations API returned. + Delegations []*DelegationMetadata `locationName:"delegations" type:"list"` + + // The pagination token that's used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation. @@ -10702,7 +12268,7 @@ type GetAssessmentFrameworkOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAssessmentFrameworkOutput) String() string { +func (s GetDelegationsOutput) String() string { return awsutil.Prettify(s) } @@ -10711,23 +12277,46 @@ func (s GetAssessmentFrameworkOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAssessmentFrameworkOutput) GoString() string { +func (s GetDelegationsOutput) GoString() string { return s.String() } -// SetFramework sets the Framework field's value. -func (s *GetAssessmentFrameworkOutput) SetFramework(v *Framework) *GetAssessmentFrameworkOutput { - s.Framework = v +// SetDelegations sets the Delegations field's value. +func (s *GetDelegationsOutput) SetDelegations(v []*DelegationMetadata) *GetDelegationsOutput { + s.Delegations = v return s } -type GetAssessmentInput struct { +// SetNextToken sets the NextToken field's value. +func (s *GetDelegationsOutput) SetNextToken(v string) *GetDelegationsOutput { + s.NextToken = &v + return s +} + +type GetEvidenceByEvidenceFolderInput struct { _ struct{} `type:"structure" nopayload:"true"` // The identifier for the assessment. // // AssessmentId is a required field AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + + // The identifier for the control set. + // + // ControlSetId is a required field + ControlSetId *string `location:"uri" locationName:"controlSetId" min:"1" type:"string" required:"true"` + + // The unique identifier for the folder that the evidence is stored in. + // + // EvidenceFolderId is a required field + EvidenceFolderId *string `location:"uri" locationName:"evidenceFolderId" min:"36" type:"string" required:"true"` + + // Represents the maximum number of results on a page or for an API request + // call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token that's used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation. @@ -10735,7 +12324,7 @@ type GetAssessmentInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAssessmentInput) String() string { +func (s GetEvidenceByEvidenceFolderInput) String() string { return awsutil.Prettify(s) } @@ -10744,19 +12333,37 @@ func (s GetAssessmentInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAssessmentInput) GoString() string { +func (s GetEvidenceByEvidenceFolderInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetAssessmentInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetAssessmentInput"} +func (s *GetEvidenceByEvidenceFolderInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetEvidenceByEvidenceFolderInput"} if s.AssessmentId == nil { invalidParams.Add(request.NewErrParamRequired("AssessmentId")) } if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) } + if s.ControlSetId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlSetId")) + } + if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) + } + if s.EvidenceFolderId == nil { + invalidParams.Add(request.NewErrParamRequired("EvidenceFolderId")) + } + if s.EvidenceFolderId != nil && len(*s.EvidenceFolderId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("EvidenceFolderId", 36)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } if invalidParams.Len() > 0 { return invalidParams @@ -10765,21 +12372,43 @@ func (s *GetAssessmentInput) Validate() error { } // SetAssessmentId sets the AssessmentId field's value. -func (s *GetAssessmentInput) SetAssessmentId(v string) *GetAssessmentInput { +func (s *GetEvidenceByEvidenceFolderInput) SetAssessmentId(v string) *GetEvidenceByEvidenceFolderInput { s.AssessmentId = &v return s } -type GetAssessmentOutput struct { +// SetControlSetId sets the ControlSetId field's value. +func (s *GetEvidenceByEvidenceFolderInput) SetControlSetId(v string) *GetEvidenceByEvidenceFolderInput { + s.ControlSetId = &v + return s +} + +// SetEvidenceFolderId sets the EvidenceFolderId field's value. +func (s *GetEvidenceByEvidenceFolderInput) SetEvidenceFolderId(v string) *GetEvidenceByEvidenceFolderInput { + s.EvidenceFolderId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *GetEvidenceByEvidenceFolderInput) SetMaxResults(v int64) *GetEvidenceByEvidenceFolderInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *GetEvidenceByEvidenceFolderInput) SetNextToken(v string) *GetEvidenceByEvidenceFolderInput { + s.NextToken = &v + return s +} + +type GetEvidenceByEvidenceFolderOutput struct { _ struct{} `type:"structure"` - // An entity that defines the scope of audit evidence collected by Audit Manager. - // An Audit Manager assessment is an implementation of an Audit Manager framework. - Assessment *Assessment `locationName:"assessment" type:"structure"` + // The list of evidence that the GetEvidenceByEvidenceFolder API returned. + Evidence []*Evidence `locationName:"evidence" type:"list"` - // The wrapper that contains the Audit Manager role information of the current - // user. This includes the role type and IAM Amazon Resource Name (ARN). - UserRole *Role `locationName:"userRole" type:"structure"` + // The pagination token that's used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation. @@ -10787,7 +12416,7 @@ type GetAssessmentOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAssessmentOutput) String() string { +func (s GetEvidenceByEvidenceFolderOutput) String() string { return awsutil.Prettify(s) } @@ -10796,34 +12425,39 @@ func (s GetAssessmentOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAssessmentOutput) GoString() string { +func (s GetEvidenceByEvidenceFolderOutput) GoString() string { return s.String() } -// SetAssessment sets the Assessment field's value. -func (s *GetAssessmentOutput) SetAssessment(v *Assessment) *GetAssessmentOutput { - s.Assessment = v +// SetEvidence sets the Evidence field's value. +func (s *GetEvidenceByEvidenceFolderOutput) SetEvidence(v []*Evidence) *GetEvidenceByEvidenceFolderOutput { + s.Evidence = v return s } -// SetUserRole sets the UserRole field's value. -func (s *GetAssessmentOutput) SetUserRole(v *Role) *GetAssessmentOutput { - s.UserRole = v +// SetNextToken sets the NextToken field's value. +func (s *GetEvidenceByEvidenceFolderOutput) SetNextToken(v string) *GetEvidenceByEvidenceFolderOutput { + s.NextToken = &v return s } -type GetAssessmentReportUrlInput struct { +type GetEvidenceFolderInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier for the assessment. + // The unique identifier for the assessment. // // AssessmentId is a required field AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` - // The identifier for the assessment report. + // The unique identifier for the control set. // - // AssessmentReportId is a required field - AssessmentReportId *string `location:"uri" locationName:"assessmentReportId" min:"36" type:"string" required:"true"` + // ControlSetId is a required field + ControlSetId *string `location:"uri" locationName:"controlSetId" min:"1" type:"string" required:"true"` + + // The unique identifier for the folder that the evidence is stored in. + // + // EvidenceFolderId is a required field + EvidenceFolderId *string `location:"uri" locationName:"evidenceFolderId" min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -10831,7 +12465,7 @@ type GetAssessmentReportUrlInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAssessmentReportUrlInput) String() string { +func (s GetEvidenceFolderInput) String() string { return awsutil.Prettify(s) } @@ -10840,24 +12474,30 @@ func (s GetAssessmentReportUrlInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAssessmentReportUrlInput) GoString() string { +func (s GetEvidenceFolderInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetAssessmentReportUrlInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetAssessmentReportUrlInput"} +func (s *GetEvidenceFolderInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetEvidenceFolderInput"} if s.AssessmentId == nil { invalidParams.Add(request.NewErrParamRequired("AssessmentId")) } if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) } - if s.AssessmentReportId == nil { - invalidParams.Add(request.NewErrParamRequired("AssessmentReportId")) + if s.ControlSetId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlSetId")) } - if s.AssessmentReportId != nil && len(*s.AssessmentReportId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("AssessmentReportId", 36)) + if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) + } + if s.EvidenceFolderId == nil { + invalidParams.Add(request.NewErrParamRequired("EvidenceFolderId")) + } + if s.EvidenceFolderId != nil && len(*s.EvidenceFolderId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("EvidenceFolderId", 36)) } if invalidParams.Len() > 0 { @@ -10867,23 +12507,28 @@ func (s *GetAssessmentReportUrlInput) Validate() error { } // SetAssessmentId sets the AssessmentId field's value. -func (s *GetAssessmentReportUrlInput) SetAssessmentId(v string) *GetAssessmentReportUrlInput { +func (s *GetEvidenceFolderInput) SetAssessmentId(v string) *GetEvidenceFolderInput { s.AssessmentId = &v return s } -// SetAssessmentReportId sets the AssessmentReportId field's value. -func (s *GetAssessmentReportUrlInput) SetAssessmentReportId(v string) *GetAssessmentReportUrlInput { - s.AssessmentReportId = &v +// SetControlSetId sets the ControlSetId field's value. +func (s *GetEvidenceFolderInput) SetControlSetId(v string) *GetEvidenceFolderInput { + s.ControlSetId = &v return s } -type GetAssessmentReportUrlOutput struct { +// SetEvidenceFolderId sets the EvidenceFolderId field's value. +func (s *GetEvidenceFolderInput) SetEvidenceFolderId(v string) *GetEvidenceFolderInput { + s.EvidenceFolderId = &v + return s +} + +type GetEvidenceFolderOutput struct { _ struct{} `type:"structure"` - // Short for uniform resource locator. A URL is used as a unique identifier - // to locate a resource on the internet. - PreSignedUrl *URL `locationName:"preSignedUrl" type:"structure"` + // The folder that the evidence is stored in. + EvidenceFolder *AssessmentEvidenceFolder `locationName:"evidenceFolder" type:"structure"` } // String returns the string representation. @@ -10891,7 +12536,7 @@ type GetAssessmentReportUrlOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAssessmentReportUrlOutput) String() string { +func (s GetEvidenceFolderOutput) String() string { return awsutil.Prettify(s) } @@ -10900,17 +12545,17 @@ func (s GetAssessmentReportUrlOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetAssessmentReportUrlOutput) GoString() string { +func (s GetEvidenceFolderOutput) GoString() string { return s.String() } -// SetPreSignedUrl sets the PreSignedUrl field's value. -func (s *GetAssessmentReportUrlOutput) SetPreSignedUrl(v *URL) *GetAssessmentReportUrlOutput { - s.PreSignedUrl = v +// SetEvidenceFolder sets the EvidenceFolder field's value. +func (s *GetEvidenceFolderOutput) SetEvidenceFolder(v *AssessmentEvidenceFolder) *GetEvidenceFolderOutput { + s.EvidenceFolder = v return s } -type GetChangeLogsInput struct { +type GetEvidenceFoldersByAssessmentControlInput struct { _ struct{} `type:"structure" nopayload:"true"` // The identifier for the assessment. @@ -10919,10 +12564,14 @@ type GetChangeLogsInput struct { AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` // The identifier for the control. - ControlId *string `location:"querystring" locationName:"controlId" min:"36" type:"string"` + // + // ControlId is a required field + ControlId *string `location:"uri" locationName:"controlId" min:"36" type:"string" required:"true"` // The identifier for the control set. - ControlSetId *string `location:"querystring" locationName:"controlSetId" min:"1" type:"string"` + // + // ControlSetId is a required field + ControlSetId *string `location:"uri" locationName:"controlSetId" min:"1" type:"string" required:"true"` // Represents the maximum number of results on a page or for an API request // call. @@ -10937,7 +12586,7 @@ type GetChangeLogsInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetChangeLogsInput) String() string { +func (s GetEvidenceFoldersByAssessmentControlInput) String() string { return awsutil.Prettify(s) } @@ -10946,22 +12595,28 @@ func (s GetChangeLogsInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetChangeLogsInput) GoString() string { +func (s GetEvidenceFoldersByAssessmentControlInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetChangeLogsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetChangeLogsInput"} +func (s *GetEvidenceFoldersByAssessmentControlInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetEvidenceFoldersByAssessmentControlInput"} if s.AssessmentId == nil { invalidParams.Add(request.NewErrParamRequired("AssessmentId")) } if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) } + if s.ControlId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlId")) + } if s.ControlId != nil && len(*s.ControlId) < 36 { invalidParams.Add(request.NewErrParamMinLen("ControlId", 36)) } + if s.ControlSetId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlSetId")) + } if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) } @@ -10979,40 +12634,41 @@ func (s *GetChangeLogsInput) Validate() error { } // SetAssessmentId sets the AssessmentId field's value. -func (s *GetChangeLogsInput) SetAssessmentId(v string) *GetChangeLogsInput { +func (s *GetEvidenceFoldersByAssessmentControlInput) SetAssessmentId(v string) *GetEvidenceFoldersByAssessmentControlInput { s.AssessmentId = &v return s } // SetControlId sets the ControlId field's value. -func (s *GetChangeLogsInput) SetControlId(v string) *GetChangeLogsInput { +func (s *GetEvidenceFoldersByAssessmentControlInput) SetControlId(v string) *GetEvidenceFoldersByAssessmentControlInput { s.ControlId = &v return s } // SetControlSetId sets the ControlSetId field's value. -func (s *GetChangeLogsInput) SetControlSetId(v string) *GetChangeLogsInput { +func (s *GetEvidenceFoldersByAssessmentControlInput) SetControlSetId(v string) *GetEvidenceFoldersByAssessmentControlInput { s.ControlSetId = &v return s } // SetMaxResults sets the MaxResults field's value. -func (s *GetChangeLogsInput) SetMaxResults(v int64) *GetChangeLogsInput { +func (s *GetEvidenceFoldersByAssessmentControlInput) SetMaxResults(v int64) *GetEvidenceFoldersByAssessmentControlInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *GetChangeLogsInput) SetNextToken(v string) *GetChangeLogsInput { +func (s *GetEvidenceFoldersByAssessmentControlInput) SetNextToken(v string) *GetEvidenceFoldersByAssessmentControlInput { s.NextToken = &v return s } -type GetChangeLogsOutput struct { +type GetEvidenceFoldersByAssessmentControlOutput struct { _ struct{} `type:"structure"` - // The list of user activity for the control. - ChangeLogs []*ChangeLog `locationName:"changeLogs" type:"list"` + // The list of evidence folders that the GetEvidenceFoldersByAssessmentControl + // API returned. + EvidenceFolders []*AssessmentEvidenceFolder `locationName:"evidenceFolders" type:"list"` // The pagination token that's used to fetch the next set of results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` @@ -11023,7 +12679,7 @@ type GetChangeLogsOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetChangeLogsOutput) String() string { +func (s GetEvidenceFoldersByAssessmentControlOutput) String() string { return awsutil.Prettify(s) } @@ -11032,104 +12688,29 @@ func (s GetChangeLogsOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetChangeLogsOutput) GoString() string { +func (s GetEvidenceFoldersByAssessmentControlOutput) GoString() string { return s.String() } -// SetChangeLogs sets the ChangeLogs field's value. -func (s *GetChangeLogsOutput) SetChangeLogs(v []*ChangeLog) *GetChangeLogsOutput { - s.ChangeLogs = v +// SetEvidenceFolders sets the EvidenceFolders field's value. +func (s *GetEvidenceFoldersByAssessmentControlOutput) SetEvidenceFolders(v []*AssessmentEvidenceFolder) *GetEvidenceFoldersByAssessmentControlOutput { + s.EvidenceFolders = v return s } // SetNextToken sets the NextToken field's value. -func (s *GetChangeLogsOutput) SetNextToken(v string) *GetChangeLogsOutput { +func (s *GetEvidenceFoldersByAssessmentControlOutput) SetNextToken(v string) *GetEvidenceFoldersByAssessmentControlOutput { s.NextToken = &v return s } -type GetControlInput struct { +type GetEvidenceFoldersByAssessmentInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier for the control. + // The unique identifier for the assessment. // - // ControlId is a required field - ControlId *string `location:"uri" locationName:"controlId" min:"36" type:"string" required:"true"` -} - -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s GetControlInput) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s GetControlInput) GoString() string { - return s.String() -} - -// Validate inspects the fields of the type to determine if they are valid. -func (s *GetControlInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetControlInput"} - if s.ControlId == nil { - invalidParams.Add(request.NewErrParamRequired("ControlId")) - } - if s.ControlId != nil && len(*s.ControlId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("ControlId", 36)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetControlId sets the ControlId field's value. -func (s *GetControlInput) SetControlId(v string) *GetControlInput { - s.ControlId = &v - return s -} - -type GetControlOutput struct { - _ struct{} `type:"structure"` - - // The name of the control that the GetControl API returned. - Control *Control `locationName:"control" type:"structure"` -} - -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s GetControlOutput) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s GetControlOutput) GoString() string { - return s.String() -} - -// SetControl sets the Control field's value. -func (s *GetControlOutput) SetControl(v *Control) *GetControlOutput { - s.Control = v - return s -} - -type GetDelegationsInput struct { - _ struct{} `type:"structure" nopayload:"true"` + // AssessmentId is a required field + AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` // Represents the maximum number of results on a page or for an API request // call. @@ -11144,7 +12725,7 @@ type GetDelegationsInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetDelegationsInput) String() string { +func (s GetEvidenceFoldersByAssessmentInput) String() string { return awsutil.Prettify(s) } @@ -11153,13 +12734,19 @@ func (s GetDelegationsInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetDelegationsInput) GoString() string { +func (s GetEvidenceFoldersByAssessmentInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetDelegationsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetDelegationsInput"} +func (s *GetEvidenceFoldersByAssessmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetEvidenceFoldersByAssessmentInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) + } if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -11173,23 +12760,30 @@ func (s *GetDelegationsInput) Validate() error { return nil } +// SetAssessmentId sets the AssessmentId field's value. +func (s *GetEvidenceFoldersByAssessmentInput) SetAssessmentId(v string) *GetEvidenceFoldersByAssessmentInput { + s.AssessmentId = &v + return s +} + // SetMaxResults sets the MaxResults field's value. -func (s *GetDelegationsInput) SetMaxResults(v int64) *GetDelegationsInput { +func (s *GetEvidenceFoldersByAssessmentInput) SetMaxResults(v int64) *GetEvidenceFoldersByAssessmentInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *GetDelegationsInput) SetNextToken(v string) *GetDelegationsInput { +func (s *GetEvidenceFoldersByAssessmentInput) SetNextToken(v string) *GetEvidenceFoldersByAssessmentInput { s.NextToken = &v return s } -type GetDelegationsOutput struct { +type GetEvidenceFoldersByAssessmentOutput struct { _ struct{} `type:"structure"` - // The list of delegations that the GetDelegations API returned. - Delegations []*DelegationMetadata `locationName:"delegations" type:"list"` + // The list of evidence folders that the GetEvidenceFoldersByAssessment API + // returned. + EvidenceFolders []*AssessmentEvidenceFolder `locationName:"evidenceFolders" type:"list"` // The pagination token that's used to fetch the next set of results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` @@ -11200,7 +12794,7 @@ type GetDelegationsOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetDelegationsOutput) String() string { +func (s GetEvidenceFoldersByAssessmentOutput) String() string { return awsutil.Prettify(s) } @@ -11209,31 +12803,31 @@ func (s GetDelegationsOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetDelegationsOutput) GoString() string { +func (s GetEvidenceFoldersByAssessmentOutput) GoString() string { return s.String() } -// SetDelegations sets the Delegations field's value. -func (s *GetDelegationsOutput) SetDelegations(v []*DelegationMetadata) *GetDelegationsOutput { - s.Delegations = v +// SetEvidenceFolders sets the EvidenceFolders field's value. +func (s *GetEvidenceFoldersByAssessmentOutput) SetEvidenceFolders(v []*AssessmentEvidenceFolder) *GetEvidenceFoldersByAssessmentOutput { + s.EvidenceFolders = v return s } // SetNextToken sets the NextToken field's value. -func (s *GetDelegationsOutput) SetNextToken(v string) *GetDelegationsOutput { +func (s *GetEvidenceFoldersByAssessmentOutput) SetNextToken(v string) *GetEvidenceFoldersByAssessmentOutput { s.NextToken = &v return s } -type GetEvidenceByEvidenceFolderInput struct { +type GetEvidenceInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier for the assessment. + // The unique identifier for the assessment. // // AssessmentId is a required field AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` - // The identifier for the control set. + // The unique identifier for the control set. // // ControlSetId is a required field ControlSetId *string `location:"uri" locationName:"controlSetId" min:"1" type:"string" required:"true"` @@ -11243,12 +12837,10 @@ type GetEvidenceByEvidenceFolderInput struct { // EvidenceFolderId is a required field EvidenceFolderId *string `location:"uri" locationName:"evidenceFolderId" min:"36" type:"string" required:"true"` - // Represents the maximum number of results on a page or for an API request - // call. - MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - - // The pagination token that's used to fetch the next set of results. - NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` + // The unique identifier for the evidence. + // + // EvidenceId is a required field + EvidenceId *string `location:"uri" locationName:"evidenceId" min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -11256,7 +12848,7 @@ type GetEvidenceByEvidenceFolderInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceByEvidenceFolderInput) String() string { +func (s GetEvidenceInput) String() string { return awsutil.Prettify(s) } @@ -11265,13 +12857,13 @@ func (s GetEvidenceByEvidenceFolderInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceByEvidenceFolderInput) GoString() string { +func (s GetEvidenceInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetEvidenceByEvidenceFolderInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetEvidenceByEvidenceFolderInput"} +func (s *GetEvidenceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetEvidenceInput"} if s.AssessmentId == nil { invalidParams.Add(request.NewErrParamRequired("AssessmentId")) } @@ -11290,11 +12882,11 @@ func (s *GetEvidenceByEvidenceFolderInput) Validate() error { if s.EvidenceFolderId != nil && len(*s.EvidenceFolderId) < 36 { invalidParams.Add(request.NewErrParamMinLen("EvidenceFolderId", 36)) } - if s.MaxResults != nil && *s.MaxResults < 1 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + if s.EvidenceId == nil { + invalidParams.Add(request.NewErrParamRequired("EvidenceId")) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + if s.EvidenceId != nil && len(*s.EvidenceId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("EvidenceId", 36)) } if invalidParams.Len() > 0 { @@ -11304,43 +12896,34 @@ func (s *GetEvidenceByEvidenceFolderInput) Validate() error { } // SetAssessmentId sets the AssessmentId field's value. -func (s *GetEvidenceByEvidenceFolderInput) SetAssessmentId(v string) *GetEvidenceByEvidenceFolderInput { +func (s *GetEvidenceInput) SetAssessmentId(v string) *GetEvidenceInput { s.AssessmentId = &v return s } // SetControlSetId sets the ControlSetId field's value. -func (s *GetEvidenceByEvidenceFolderInput) SetControlSetId(v string) *GetEvidenceByEvidenceFolderInput { +func (s *GetEvidenceInput) SetControlSetId(v string) *GetEvidenceInput { s.ControlSetId = &v return s } // SetEvidenceFolderId sets the EvidenceFolderId field's value. -func (s *GetEvidenceByEvidenceFolderInput) SetEvidenceFolderId(v string) *GetEvidenceByEvidenceFolderInput { +func (s *GetEvidenceInput) SetEvidenceFolderId(v string) *GetEvidenceInput { s.EvidenceFolderId = &v return s } -// SetMaxResults sets the MaxResults field's value. -func (s *GetEvidenceByEvidenceFolderInput) SetMaxResults(v int64) *GetEvidenceByEvidenceFolderInput { - s.MaxResults = &v - return s -} - -// SetNextToken sets the NextToken field's value. -func (s *GetEvidenceByEvidenceFolderInput) SetNextToken(v string) *GetEvidenceByEvidenceFolderInput { - s.NextToken = &v +// SetEvidenceId sets the EvidenceId field's value. +func (s *GetEvidenceInput) SetEvidenceId(v string) *GetEvidenceInput { + s.EvidenceId = &v return s } -type GetEvidenceByEvidenceFolderOutput struct { +type GetEvidenceOutput struct { _ struct{} `type:"structure"` - // The list of evidence that the GetEvidenceByEvidenceFolder API returned. - Evidence []*Evidence `locationName:"evidence" type:"list"` - - // The pagination token that's used to fetch the next set of results. - NextToken *string `locationName:"nextToken" min:"1" type:"string"` + // The evidence that the GetEvidenceResponse API returned. + Evidence *Evidence `locationName:"evidence" type:"structure"` } // String returns the string representation. @@ -11348,7 +12931,7 @@ type GetEvidenceByEvidenceFolderOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceByEvidenceFolderOutput) String() string { +func (s GetEvidenceOutput) String() string { return awsutil.Prettify(s) } @@ -11357,39 +12940,23 @@ func (s GetEvidenceByEvidenceFolderOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceByEvidenceFolderOutput) GoString() string { +func (s GetEvidenceOutput) GoString() string { return s.String() } // SetEvidence sets the Evidence field's value. -func (s *GetEvidenceByEvidenceFolderOutput) SetEvidence(v []*Evidence) *GetEvidenceByEvidenceFolderOutput { +func (s *GetEvidenceOutput) SetEvidence(v *Evidence) *GetEvidenceOutput { s.Evidence = v return s } -// SetNextToken sets the NextToken field's value. -func (s *GetEvidenceByEvidenceFolderOutput) SetNextToken(v string) *GetEvidenceByEvidenceFolderOutput { - s.NextToken = &v - return s -} - -type GetEvidenceFolderInput struct { +type GetInsightsByAssessmentInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier for the assessment. + // The unique identifier for the assessment. // // AssessmentId is a required field AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` - - // The identifier for the control set. - // - // ControlSetId is a required field - ControlSetId *string `location:"uri" locationName:"controlSetId" min:"1" type:"string" required:"true"` - - // The identifier for the folder that the evidence is stored in. - // - // EvidenceFolderId is a required field - EvidenceFolderId *string `location:"uri" locationName:"evidenceFolderId" min:"36" type:"string" required:"true"` } // String returns the string representation. @@ -11397,7 +12964,7 @@ type GetEvidenceFolderInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceFolderInput) String() string { +func (s GetInsightsByAssessmentInput) String() string { return awsutil.Prettify(s) } @@ -11406,31 +12973,19 @@ func (s GetEvidenceFolderInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceFolderInput) GoString() string { +func (s GetInsightsByAssessmentInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetEvidenceFolderInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetEvidenceFolderInput"} +func (s *GetInsightsByAssessmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetInsightsByAssessmentInput"} if s.AssessmentId == nil { invalidParams.Add(request.NewErrParamRequired("AssessmentId")) } if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) } - if s.ControlSetId == nil { - invalidParams.Add(request.NewErrParamRequired("ControlSetId")) - } - if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) - } - if s.EvidenceFolderId == nil { - invalidParams.Add(request.NewErrParamRequired("EvidenceFolderId")) - } - if s.EvidenceFolderId != nil && len(*s.EvidenceFolderId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("EvidenceFolderId", 36)) - } if invalidParams.Len() > 0 { return invalidParams @@ -11439,28 +12994,184 @@ func (s *GetEvidenceFolderInput) Validate() error { } // SetAssessmentId sets the AssessmentId field's value. -func (s *GetEvidenceFolderInput) SetAssessmentId(v string) *GetEvidenceFolderInput { +func (s *GetInsightsByAssessmentInput) SetAssessmentId(v string) *GetInsightsByAssessmentInput { s.AssessmentId = &v return s } -// SetControlSetId sets the ControlSetId field's value. -func (s *GetEvidenceFolderInput) SetControlSetId(v string) *GetEvidenceFolderInput { - s.ControlSetId = &v +type GetInsightsByAssessmentOutput struct { + _ struct{} `type:"structure"` + + // The assessment analytics data that the GetInsightsByAssessment API returned. + Insights *InsightsByAssessment `locationName:"insights" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetInsightsByAssessmentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetInsightsByAssessmentOutput) GoString() string { + return s.String() +} + +// SetInsights sets the Insights field's value. +func (s *GetInsightsByAssessmentOutput) SetInsights(v *InsightsByAssessment) *GetInsightsByAssessmentOutput { + s.Insights = v return s } -// SetEvidenceFolderId sets the EvidenceFolderId field's value. -func (s *GetEvidenceFolderInput) SetEvidenceFolderId(v string) *GetEvidenceFolderInput { - s.EvidenceFolderId = &v +type GetInsightsInput struct { + _ struct{} `type:"structure" nopayload:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetInsightsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetInsightsInput) GoString() string { + return s.String() +} + +type GetInsightsOutput struct { + _ struct{} `type:"structure"` + + // The analytics data that the GetInsights API returned. + Insights *Insights `locationName:"insights" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetInsightsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetInsightsOutput) GoString() string { + return s.String() +} + +// SetInsights sets the Insights field's value. +func (s *GetInsightsOutput) SetInsights(v *Insights) *GetInsightsOutput { + s.Insights = v return s } -type GetEvidenceFolderOutput struct { +type GetOrganizationAdminAccountInput struct { + _ struct{} `type:"structure" nopayload:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetOrganizationAdminAccountInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetOrganizationAdminAccountInput) GoString() string { + return s.String() +} + +type GetOrganizationAdminAccountOutput struct { _ struct{} `type:"structure"` - // The folder that the evidence is stored in. - EvidenceFolder *AssessmentEvidenceFolder `locationName:"evidenceFolder" type:"structure"` + // The identifier for the administrator account. + AdminAccountId *string `locationName:"adminAccountId" min:"12" type:"string"` + + // The identifier for the organization. + OrganizationId *string `locationName:"organizationId" min:"12" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetOrganizationAdminAccountOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetOrganizationAdminAccountOutput) GoString() string { + return s.String() +} + +// SetAdminAccountId sets the AdminAccountId field's value. +func (s *GetOrganizationAdminAccountOutput) SetAdminAccountId(v string) *GetOrganizationAdminAccountOutput { + s.AdminAccountId = &v + return s +} + +// SetOrganizationId sets the OrganizationId field's value. +func (s *GetOrganizationAdminAccountOutput) SetOrganizationId(v string) *GetOrganizationAdminAccountOutput { + s.OrganizationId = &v + return s +} + +type GetServicesInScopeInput struct { + _ struct{} `type:"structure" nopayload:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetServicesInScopeInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetServicesInScopeInput) GoString() string { + return s.String() +} + +type GetServicesInScopeOutput struct { + _ struct{} `type:"structure"` + + // The metadata that's associated with the Amazon Web Service. + ServiceMetadata []*ServiceMetadata `locationName:"serviceMetadata" type:"list"` } // String returns the string representation. @@ -11468,7 +13179,7 @@ type GetEvidenceFolderOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceFolderOutput) String() string { +func (s GetServicesInScopeOutput) String() string { return awsutil.Prettify(s) } @@ -11477,40 +13188,23 @@ func (s GetEvidenceFolderOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceFolderOutput) GoString() string { +func (s GetServicesInScopeOutput) GoString() string { return s.String() } -// SetEvidenceFolder sets the EvidenceFolder field's value. -func (s *GetEvidenceFolderOutput) SetEvidenceFolder(v *AssessmentEvidenceFolder) *GetEvidenceFolderOutput { - s.EvidenceFolder = v +// SetServiceMetadata sets the ServiceMetadata field's value. +func (s *GetServicesInScopeOutput) SetServiceMetadata(v []*ServiceMetadata) *GetServicesInScopeOutput { + s.ServiceMetadata = v return s } -type GetEvidenceFoldersByAssessmentControlInput struct { +type GetSettingsInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier for the assessment. - // - // AssessmentId is a required field - AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` - - // The identifier for the control. - // - // ControlId is a required field - ControlId *string `location:"uri" locationName:"controlId" min:"36" type:"string" required:"true"` - - // The identifier for the control set. + // The list of SettingAttribute enum values. // - // ControlSetId is a required field - ControlSetId *string `location:"uri" locationName:"controlSetId" min:"1" type:"string" required:"true"` - - // Represents the maximum number of results on a page or for an API request - // call. - MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - - // The pagination token that's used to fetch the next set of results. - NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` + // Attribute is a required field + Attribute *string `location:"uri" locationName:"attribute" type:"string" required:"true" enum:"SettingAttribute"` } // String returns the string representation. @@ -11518,7 +13212,7 @@ type GetEvidenceFoldersByAssessmentControlInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceFoldersByAssessmentControlInput) String() string { +func (s GetSettingsInput) String() string { return awsutil.Prettify(s) } @@ -11527,36 +13221,18 @@ func (s GetEvidenceFoldersByAssessmentControlInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceFoldersByAssessmentControlInput) GoString() string { +func (s GetSettingsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetEvidenceFoldersByAssessmentControlInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetEvidenceFoldersByAssessmentControlInput"} - if s.AssessmentId == nil { - invalidParams.Add(request.NewErrParamRequired("AssessmentId")) - } - if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) - } - if s.ControlId == nil { - invalidParams.Add(request.NewErrParamRequired("ControlId")) - } - if s.ControlId != nil && len(*s.ControlId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("ControlId", 36)) - } - if s.ControlSetId == nil { - invalidParams.Add(request.NewErrParamRequired("ControlSetId")) - } - if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) - } - if s.MaxResults != nil && *s.MaxResults < 1 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) +func (s *GetSettingsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetSettingsInput"} + if s.Attribute == nil { + invalidParams.Add(request.NewErrParamRequired("Attribute")) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + if s.Attribute != nil && len(*s.Attribute) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Attribute", 1)) } if invalidParams.Len() > 0 { @@ -11565,45 +13241,102 @@ func (s *GetEvidenceFoldersByAssessmentControlInput) Validate() error { return nil } -// SetAssessmentId sets the AssessmentId field's value. -func (s *GetEvidenceFoldersByAssessmentControlInput) SetAssessmentId(v string) *GetEvidenceFoldersByAssessmentControlInput { - s.AssessmentId = &v +// SetAttribute sets the Attribute field's value. +func (s *GetSettingsInput) SetAttribute(v string) *GetSettingsInput { + s.Attribute = &v return s } -// SetControlId sets the ControlId field's value. -func (s *GetEvidenceFoldersByAssessmentControlInput) SetControlId(v string) *GetEvidenceFoldersByAssessmentControlInput { - s.ControlId = &v - return s +type GetSettingsOutput struct { + _ struct{} `type:"structure"` + + // The settings object that holds all supported Audit Manager settings. + Settings *Settings `locationName:"settings" type:"structure"` } -// SetControlSetId sets the ControlSetId field's value. -func (s *GetEvidenceFoldersByAssessmentControlInput) SetControlSetId(v string) *GetEvidenceFoldersByAssessmentControlInput { - s.ControlSetId = &v - return s +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetSettingsOutput) String() string { + return awsutil.Prettify(s) } -// SetMaxResults sets the MaxResults field's value. -func (s *GetEvidenceFoldersByAssessmentControlInput) SetMaxResults(v int64) *GetEvidenceFoldersByAssessmentControlInput { - s.MaxResults = &v - return s +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s GetSettingsOutput) GoString() string { + return s.String() } -// SetNextToken sets the NextToken field's value. -func (s *GetEvidenceFoldersByAssessmentControlInput) SetNextToken(v string) *GetEvidenceFoldersByAssessmentControlInput { - s.NextToken = &v +// SetSettings sets the Settings field's value. +func (s *GetSettingsOutput) SetSettings(v *Settings) *GetSettingsOutput { + s.Settings = v return s } -type GetEvidenceFoldersByAssessmentControlOutput struct { +// A summary of the latest analytics data for all your active assessments. +// +// This summary is a snapshot of the data that your active assessments collected +// on the lastUpdated date. It’s important to understand that the following +// totals are daily counts based on this date — they aren’t a total sum +// to date. +// +// The Insights data is eventually consistent. This means that, when you read +// data from Insights, the response might not instantly reflect the results +// of a recently completed write or update operation. If you repeat your read +// request after a few hours, the response should return the latest data. +// +// If you delete an assessment or change its status to inactive, InsightsByAssessment +// includes data for that assessment as follows. +// +// * Inactive assessments - If Audit Manager collected evidence for your +// assessment before you changed it inactive, that evidence is included in +// the InsightsByAssessment counts for that day. +// +// * Deleted assessments - If Audit Manager collected evidence for your assessment +// before you deleted it, that evidence isn't included in the InsightsByAssessment +// counts for that day. +type Insights struct { _ struct{} `type:"structure"` - // The list of evidence folders that the GetEvidenceFoldersByAssessmentControl - // API returned. - EvidenceFolders []*AssessmentEvidenceFolder `locationName:"evidenceFolders" type:"list"` + // The number of active assessments in Audit Manager. + ActiveAssessmentsCount *int64 `locationName:"activeAssessmentsCount" type:"integer"` - // The pagination token that's used to fetch the next set of results. - NextToken *string `locationName:"nextToken" min:"1" type:"string"` + // The number of assessment controls that collected non-compliant evidence on + // the lastUpdated date. + AssessmentControlsCountByNoncompliantEvidence *int64 `locationName:"assessmentControlsCountByNoncompliantEvidence" type:"integer"` + + // The number of compliance check evidence that Audit Manager classified as + // compliant on the lastUpdated date. This includes evidence that was collected + // from Security Hub with a Pass ruling, or collected from Config with a Compliant + // ruling. + CompliantEvidenceCount *int64 `locationName:"compliantEvidenceCount" type:"integer"` + + // The number of evidence without a compliance check ruling. Evidence is inconclusive + // when the associated control uses Security Hub or Config as a data source + // but you didn't enable those services. This is also the case when a control + // uses a data source that doesn’t support compliance checks (for example: + // manual evidence, API calls, or CloudTrail). + // + // If evidence has a compliance check status of not applicable, it's classed + // as inconclusive in Insights data. + InconclusiveEvidenceCount *int64 `locationName:"inconclusiveEvidenceCount" type:"integer"` + + // The time when the cross-assessment insights were last updated. + LastUpdated *time.Time `locationName:"lastUpdated" type:"timestamp"` + + // The number of compliance check evidence that Audit Manager classified as + // non-compliant on the lastUpdated date. This includes evidence that was collected + // from Security Hub with a Fail ruling, or collected from Config with a Non-compliant + // ruling. + NoncompliantEvidenceCount *int64 `locationName:"noncompliantEvidenceCount" type:"integer"` + + // The total number of controls across all active assessments. + TotalAssessmentControlsCount *int64 `locationName:"totalAssessmentControlsCount" type:"integer"` } // String returns the string representation. @@ -11611,7 +13344,7 @@ type GetEvidenceFoldersByAssessmentControlOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceFoldersByAssessmentControlOutput) String() string { +func (s Insights) String() string { return awsutil.Prettify(s) } @@ -11620,36 +13353,106 @@ func (s GetEvidenceFoldersByAssessmentControlOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceFoldersByAssessmentControlOutput) GoString() string { +func (s Insights) GoString() string { return s.String() } -// SetEvidenceFolders sets the EvidenceFolders field's value. -func (s *GetEvidenceFoldersByAssessmentControlOutput) SetEvidenceFolders(v []*AssessmentEvidenceFolder) *GetEvidenceFoldersByAssessmentControlOutput { - s.EvidenceFolders = v +// SetActiveAssessmentsCount sets the ActiveAssessmentsCount field's value. +func (s *Insights) SetActiveAssessmentsCount(v int64) *Insights { + s.ActiveAssessmentsCount = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *GetEvidenceFoldersByAssessmentControlOutput) SetNextToken(v string) *GetEvidenceFoldersByAssessmentControlOutput { - s.NextToken = &v +// SetAssessmentControlsCountByNoncompliantEvidence sets the AssessmentControlsCountByNoncompliantEvidence field's value. +func (s *Insights) SetAssessmentControlsCountByNoncompliantEvidence(v int64) *Insights { + s.AssessmentControlsCountByNoncompliantEvidence = &v return s } -type GetEvidenceFoldersByAssessmentInput struct { - _ struct{} `type:"structure" nopayload:"true"` +// SetCompliantEvidenceCount sets the CompliantEvidenceCount field's value. +func (s *Insights) SetCompliantEvidenceCount(v int64) *Insights { + s.CompliantEvidenceCount = &v + return s +} - // The identifier for the assessment. +// SetInconclusiveEvidenceCount sets the InconclusiveEvidenceCount field's value. +func (s *Insights) SetInconclusiveEvidenceCount(v int64) *Insights { + s.InconclusiveEvidenceCount = &v + return s +} + +// SetLastUpdated sets the LastUpdated field's value. +func (s *Insights) SetLastUpdated(v time.Time) *Insights { + s.LastUpdated = &v + return s +} + +// SetNoncompliantEvidenceCount sets the NoncompliantEvidenceCount field's value. +func (s *Insights) SetNoncompliantEvidenceCount(v int64) *Insights { + s.NoncompliantEvidenceCount = &v + return s +} + +// SetTotalAssessmentControlsCount sets the TotalAssessmentControlsCount field's value. +func (s *Insights) SetTotalAssessmentControlsCount(v int64) *Insights { + s.TotalAssessmentControlsCount = &v + return s +} + +// A summary of the latest analytics data for a specific active assessment. +// +// This summary is a snapshot of the data that was collected on the lastUpdated +// date. It’s important to understand that the totals in InsightsByAssessment +// are daily counts based on this date — they aren’t a total sum to date. +// +// The InsightsByAssessment data is eventually consistent. This means that when +// you read data from InsightsByAssessment, the response might not instantly +// reflect the results of a recently completed write or update operation. If +// you repeat your read request after a few hours, the response returns the +// latest data. +// +// If you delete an assessment or change its status to inactive, InsightsByAssessment +// includes data for that assessment as follows. +// +// * Inactive assessments - If Audit Manager collected evidence for your +// assessment before you changed it inactive, that evidence is included in +// the InsightsByAssessment counts for that day. +// +// * Deleted assessments - If Audit Manager collected evidence for your assessment +// before you deleted it, that evidence isn't included in the InsightsByAssessment +// counts for that day. +type InsightsByAssessment struct { + _ struct{} `type:"structure"` + + // The number of assessment controls that collected non-compliant evidence on + // the lastUpdated date. + AssessmentControlsCountByNoncompliantEvidence *int64 `locationName:"assessmentControlsCountByNoncompliantEvidence" type:"integer"` + + // The number of compliance check evidence that Audit Manager classified as + // compliant. This includes evidence that was collected from Security Hub with + // a Pass ruling, or collected from Config with a Compliant ruling. + CompliantEvidenceCount *int64 `locationName:"compliantEvidenceCount" type:"integer"` + + // The amount of evidence without a compliance check ruling. Evidence is inconclusive + // if the associated control uses Security Hub or Config as a data source and + // you didn't enable those services. This is also the case if a control uses + // a data source that doesn’t support compliance checks (for example, manual + // evidence, API calls, or CloudTrail). // - // AssessmentId is a required field - AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + // If evidence has a compliance check status of not applicable, it's classified + // as inconclusive in InsightsByAssessment data. + InconclusiveEvidenceCount *int64 `locationName:"inconclusiveEvidenceCount" type:"integer"` - // Represents the maximum number of results on a page or for an API request - // call. - MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + // The time when the assessment insights were last updated. + LastUpdated *time.Time `locationName:"lastUpdated" type:"timestamp"` - // The pagination token that's used to fetch the next set of results. - NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` + // The number of compliance check evidence that Audit Manager classified as + // non-compliant. This includes evidence that was collected from Security Hub + // with a Fail ruling, or collected from Config with a Non-compliant ruling. + NoncompliantEvidenceCount *int64 `locationName:"noncompliantEvidenceCount" type:"integer"` + + // The total number of controls in the assessment. + TotalAssessmentControlsCount *int64 `locationName:"totalAssessmentControlsCount" type:"integer"` } // String returns the string representation. @@ -11657,7 +13460,7 @@ type GetEvidenceFoldersByAssessmentInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceFoldersByAssessmentInput) String() string { +func (s InsightsByAssessment) String() string { return awsutil.Prettify(s) } @@ -11666,59 +13469,53 @@ func (s GetEvidenceFoldersByAssessmentInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceFoldersByAssessmentInput) GoString() string { +func (s InsightsByAssessment) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *GetEvidenceFoldersByAssessmentInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetEvidenceFoldersByAssessmentInput"} - if s.AssessmentId == nil { - invalidParams.Add(request.NewErrParamRequired("AssessmentId")) - } - if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) - } - if s.MaxResults != nil && *s.MaxResults < 1 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) - } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) - } +// SetAssessmentControlsCountByNoncompliantEvidence sets the AssessmentControlsCountByNoncompliantEvidence field's value. +func (s *InsightsByAssessment) SetAssessmentControlsCountByNoncompliantEvidence(v int64) *InsightsByAssessment { + s.AssessmentControlsCountByNoncompliantEvidence = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetCompliantEvidenceCount sets the CompliantEvidenceCount field's value. +func (s *InsightsByAssessment) SetCompliantEvidenceCount(v int64) *InsightsByAssessment { + s.CompliantEvidenceCount = &v + return s } -// SetAssessmentId sets the AssessmentId field's value. -func (s *GetEvidenceFoldersByAssessmentInput) SetAssessmentId(v string) *GetEvidenceFoldersByAssessmentInput { - s.AssessmentId = &v +// SetInconclusiveEvidenceCount sets the InconclusiveEvidenceCount field's value. +func (s *InsightsByAssessment) SetInconclusiveEvidenceCount(v int64) *InsightsByAssessment { + s.InconclusiveEvidenceCount = &v return s } -// SetMaxResults sets the MaxResults field's value. -func (s *GetEvidenceFoldersByAssessmentInput) SetMaxResults(v int64) *GetEvidenceFoldersByAssessmentInput { - s.MaxResults = &v +// SetLastUpdated sets the LastUpdated field's value. +func (s *InsightsByAssessment) SetLastUpdated(v time.Time) *InsightsByAssessment { + s.LastUpdated = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *GetEvidenceFoldersByAssessmentInput) SetNextToken(v string) *GetEvidenceFoldersByAssessmentInput { - s.NextToken = &v +// SetNoncompliantEvidenceCount sets the NoncompliantEvidenceCount field's value. +func (s *InsightsByAssessment) SetNoncompliantEvidenceCount(v int64) *InsightsByAssessment { + s.NoncompliantEvidenceCount = &v return s } -type GetEvidenceFoldersByAssessmentOutput struct { - _ struct{} `type:"structure"` +// SetTotalAssessmentControlsCount sets the TotalAssessmentControlsCount field's value. +func (s *InsightsByAssessment) SetTotalAssessmentControlsCount(v int64) *InsightsByAssessment { + s.TotalAssessmentControlsCount = &v + return s +} - // The list of evidence folders that the GetEvidenceFoldersByAssessment API - // returned. - EvidenceFolders []*AssessmentEvidenceFolder `locationName:"evidenceFolders" type:"list"` +// An internal service error occurred during the processing of your request. +// Try again later. +type InternalServerException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - // The pagination token that's used to fetch the next set of results. - NextToken *string `locationName:"nextToken" min:"1" type:"string"` + Message_ *string `locationName:"message" type:"string"` } // String returns the string representation. @@ -11726,7 +13523,7 @@ type GetEvidenceFoldersByAssessmentOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceFoldersByAssessmentOutput) String() string { +func (s InternalServerException) String() string { return awsutil.Prettify(s) } @@ -11735,44 +13532,67 @@ func (s GetEvidenceFoldersByAssessmentOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceFoldersByAssessmentOutput) GoString() string { +func (s InternalServerException) GoString() string { return s.String() } -// SetEvidenceFolders sets the EvidenceFolders field's value. -func (s *GetEvidenceFoldersByAssessmentOutput) SetEvidenceFolders(v []*AssessmentEvidenceFolder) *GetEvidenceFoldersByAssessmentOutput { - s.EvidenceFolders = v - return s +func newErrorInternalServerException(v protocol.ResponseMetadata) error { + return &InternalServerException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *InternalServerException) Code() string { + return "InternalServerException" +} + +// Message returns the exception's message. +func (s *InternalServerException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InternalServerException) OrigErr() error { + return nil +} + +func (s *InternalServerException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *InternalServerException) StatusCode() int { + return s.RespMetadata.StatusCode } -// SetNextToken sets the NextToken field's value. -func (s *GetEvidenceFoldersByAssessmentOutput) SetNextToken(v string) *GetEvidenceFoldersByAssessmentOutput { - s.NextToken = &v - return s +// RequestID returns the service's response RequestID for request. +func (s *InternalServerException) RequestID() string { + return s.RespMetadata.RequestID } -type GetEvidenceInput struct { +type ListAssessmentControlInsightsByControlDomainInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The identifier for the assessment. + // The unique identifier for the active assessment. // // AssessmentId is a required field - AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` + AssessmentId *string `location:"querystring" locationName:"assessmentId" min:"36" type:"string" required:"true"` - // The identifier for the control set. + // The unique identifier for the control domain. // - // ControlSetId is a required field - ControlSetId *string `location:"uri" locationName:"controlSetId" min:"1" type:"string" required:"true"` + // ControlDomainId is a required field + ControlDomainId *string `location:"querystring" locationName:"controlDomainId" min:"36" type:"string" required:"true"` - // The identifier for the folder that the evidence is stored in. - // - // EvidenceFolderId is a required field - EvidenceFolderId *string `location:"uri" locationName:"evidenceFolderId" min:"36" type:"string" required:"true"` + // Represents the maximum number of results on a page or for an API request + // call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // The identifier for the evidence. - // - // EvidenceId is a required field - EvidenceId *string `location:"uri" locationName:"evidenceId" min:"36" type:"string" required:"true"` + // The pagination token that's used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation. @@ -11780,7 +13600,7 @@ type GetEvidenceInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceInput) String() string { +func (s ListAssessmentControlInsightsByControlDomainInput) String() string { return awsutil.Prettify(s) } @@ -11789,36 +13609,30 @@ func (s GetEvidenceInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceInput) GoString() string { +func (s ListAssessmentControlInsightsByControlDomainInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetEvidenceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetEvidenceInput"} +func (s *ListAssessmentControlInsightsByControlDomainInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAssessmentControlInsightsByControlDomainInput"} if s.AssessmentId == nil { invalidParams.Add(request.NewErrParamRequired("AssessmentId")) } if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) } - if s.ControlSetId == nil { - invalidParams.Add(request.NewErrParamRequired("ControlSetId")) - } - if s.ControlSetId != nil && len(*s.ControlSetId) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ControlSetId", 1)) - } - if s.EvidenceFolderId == nil { - invalidParams.Add(request.NewErrParamRequired("EvidenceFolderId")) + if s.ControlDomainId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlDomainId")) } - if s.EvidenceFolderId != nil && len(*s.EvidenceFolderId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("EvidenceFolderId", 36)) + if s.ControlDomainId != nil && len(*s.ControlDomainId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ControlDomainId", 36)) } - if s.EvidenceId == nil { - invalidParams.Add(request.NewErrParamRequired("EvidenceId")) + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } - if s.EvidenceId != nil && len(*s.EvidenceId) < 36 { - invalidParams.Add(request.NewErrParamMinLen("EvidenceId", 36)) + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } if invalidParams.Len() > 0 { @@ -11828,34 +13642,38 @@ func (s *GetEvidenceInput) Validate() error { } // SetAssessmentId sets the AssessmentId field's value. -func (s *GetEvidenceInput) SetAssessmentId(v string) *GetEvidenceInput { +func (s *ListAssessmentControlInsightsByControlDomainInput) SetAssessmentId(v string) *ListAssessmentControlInsightsByControlDomainInput { s.AssessmentId = &v return s } -// SetControlSetId sets the ControlSetId field's value. -func (s *GetEvidenceInput) SetControlSetId(v string) *GetEvidenceInput { - s.ControlSetId = &v +// SetControlDomainId sets the ControlDomainId field's value. +func (s *ListAssessmentControlInsightsByControlDomainInput) SetControlDomainId(v string) *ListAssessmentControlInsightsByControlDomainInput { + s.ControlDomainId = &v return s } -// SetEvidenceFolderId sets the EvidenceFolderId field's value. -func (s *GetEvidenceInput) SetEvidenceFolderId(v string) *GetEvidenceInput { - s.EvidenceFolderId = &v +// SetMaxResults sets the MaxResults field's value. +func (s *ListAssessmentControlInsightsByControlDomainInput) SetMaxResults(v int64) *ListAssessmentControlInsightsByControlDomainInput { + s.MaxResults = &v return s } -// SetEvidenceId sets the EvidenceId field's value. -func (s *GetEvidenceInput) SetEvidenceId(v string) *GetEvidenceInput { - s.EvidenceId = &v +// SetNextToken sets the NextToken field's value. +func (s *ListAssessmentControlInsightsByControlDomainInput) SetNextToken(v string) *ListAssessmentControlInsightsByControlDomainInput { + s.NextToken = &v return s } -type GetEvidenceOutput struct { +type ListAssessmentControlInsightsByControlDomainOutput struct { _ struct{} `type:"structure"` - // The evidence that the GetEvidenceResponse API returned. - Evidence *Evidence `locationName:"evidence" type:"structure"` + // The assessment control analytics data that the ListAssessmentControlInsightsByControlDomain + // API returned. + ControlInsightsByAssessment []*ControlInsightsMetadataByAssessmentItem `locationName:"controlInsightsByAssessment" type:"list"` + + // The pagination token that's used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation. @@ -11863,7 +13681,7 @@ type GetEvidenceOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceOutput) String() string { +func (s ListAssessmentControlInsightsByControlDomainOutput) String() string { return awsutil.Prettify(s) } @@ -11872,46 +13690,36 @@ func (s GetEvidenceOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetEvidenceOutput) GoString() string { +func (s ListAssessmentControlInsightsByControlDomainOutput) GoString() string { return s.String() } -// SetEvidence sets the Evidence field's value. -func (s *GetEvidenceOutput) SetEvidence(v *Evidence) *GetEvidenceOutput { - s.Evidence = v +// SetControlInsightsByAssessment sets the ControlInsightsByAssessment field's value. +func (s *ListAssessmentControlInsightsByControlDomainOutput) SetControlInsightsByAssessment(v []*ControlInsightsMetadataByAssessmentItem) *ListAssessmentControlInsightsByControlDomainOutput { + s.ControlInsightsByAssessment = v return s } -type GetOrganizationAdminAccountInput struct { - _ struct{} `type:"structure" nopayload:"true"` -} - -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s GetOrganizationAdminAccountInput) String() string { - return awsutil.Prettify(s) +// SetNextToken sets the NextToken field's value. +func (s *ListAssessmentControlInsightsByControlDomainOutput) SetNextToken(v string) *ListAssessmentControlInsightsByControlDomainOutput { + s.NextToken = &v + return s } -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s GetOrganizationAdminAccountInput) GoString() string { - return s.String() -} +type ListAssessmentFrameworkShareRequestsInput struct { + _ struct{} `type:"structure" nopayload:"true"` -type GetOrganizationAdminAccountOutput struct { - _ struct{} `type:"structure"` + // Represents the maximum number of results on a page or for an API request + // call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // The identifier for the administrator account. - AdminAccountId *string `locationName:"adminAccountId" min:"12" type:"string"` + // The pagination token that's used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` - // The identifier for the organization. - OrganizationId *string `locationName:"organizationId" min:"12" type:"string"` + // Specifies whether the share request is a sent request or a received request. + // + // RequestType is a required field + RequestType *string `location:"querystring" locationName:"requestType" type:"string" required:"true" enum:"ShareRequestType"` } // String returns the string representation. @@ -11919,7 +13727,7 @@ type GetOrganizationAdminAccountOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetOrganizationAdminAccountOutput) String() string { +func (s ListAssessmentFrameworkShareRequestsInput) String() string { return awsutil.Prettify(s) } @@ -11928,49 +13736,56 @@ func (s GetOrganizationAdminAccountOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetOrganizationAdminAccountOutput) GoString() string { +func (s ListAssessmentFrameworkShareRequestsInput) GoString() string { return s.String() } -// SetAdminAccountId sets the AdminAccountId field's value. -func (s *GetOrganizationAdminAccountOutput) SetAdminAccountId(v string) *GetOrganizationAdminAccountOutput { - s.AdminAccountId = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAssessmentFrameworkShareRequestsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAssessmentFrameworkShareRequestsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.RequestType == nil { + invalidParams.Add(request.NewErrParamRequired("RequestType")) + } -// SetOrganizationId sets the OrganizationId field's value. -func (s *GetOrganizationAdminAccountOutput) SetOrganizationId(v string) *GetOrganizationAdminAccountOutput { - s.OrganizationId = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -type GetServicesInScopeInput struct { - _ struct{} `type:"structure" nopayload:"true"` +// SetMaxResults sets the MaxResults field's value. +func (s *ListAssessmentFrameworkShareRequestsInput) SetMaxResults(v int64) *ListAssessmentFrameworkShareRequestsInput { + s.MaxResults = &v + return s } -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s GetServicesInScopeInput) String() string { - return awsutil.Prettify(s) +// SetNextToken sets the NextToken field's value. +func (s *ListAssessmentFrameworkShareRequestsInput) SetNextToken(v string) *ListAssessmentFrameworkShareRequestsInput { + s.NextToken = &v + return s } -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s GetServicesInScopeInput) GoString() string { - return s.String() +// SetRequestType sets the RequestType field's value. +func (s *ListAssessmentFrameworkShareRequestsInput) SetRequestType(v string) *ListAssessmentFrameworkShareRequestsInput { + s.RequestType = &v + return s } -type GetServicesInScopeOutput struct { +type ListAssessmentFrameworkShareRequestsOutput struct { _ struct{} `type:"structure"` - // The metadata that's associated with the Amazon Web Service. - ServiceMetadata []*ServiceMetadata `locationName:"serviceMetadata" type:"list"` + // The list of share requests that the ListAssessmentFrameworkShareRequests + // API returned. + AssessmentFrameworkShareRequests []*AssessmentFrameworkShareRequest `locationName:"assessmentFrameworkShareRequests" type:"list"` + + // The pagination token that's used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation. @@ -11978,7 +13793,7 @@ type GetServicesInScopeOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetServicesInScopeOutput) String() string { +func (s ListAssessmentFrameworkShareRequestsOutput) String() string { return awsutil.Prettify(s) } @@ -11987,23 +13802,36 @@ func (s GetServicesInScopeOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetServicesInScopeOutput) GoString() string { +func (s ListAssessmentFrameworkShareRequestsOutput) GoString() string { return s.String() } -// SetServiceMetadata sets the ServiceMetadata field's value. -func (s *GetServicesInScopeOutput) SetServiceMetadata(v []*ServiceMetadata) *GetServicesInScopeOutput { - s.ServiceMetadata = v +// SetAssessmentFrameworkShareRequests sets the AssessmentFrameworkShareRequests field's value. +func (s *ListAssessmentFrameworkShareRequestsOutput) SetAssessmentFrameworkShareRequests(v []*AssessmentFrameworkShareRequest) *ListAssessmentFrameworkShareRequestsOutput { + s.AssessmentFrameworkShareRequests = v return s } -type GetSettingsInput struct { +// SetNextToken sets the NextToken field's value. +func (s *ListAssessmentFrameworkShareRequestsOutput) SetNextToken(v string) *ListAssessmentFrameworkShareRequestsOutput { + s.NextToken = &v + return s +} + +type ListAssessmentFrameworksInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The list of SettingAttribute enum values. + // The type of framework, such as a standard framework or a custom framework. // - // Attribute is a required field - Attribute *string `location:"uri" locationName:"attribute" type:"string" required:"true" enum:"SettingAttribute"` + // FrameworkType is a required field + FrameworkType *string `location:"querystring" locationName:"frameworkType" type:"string" required:"true" enum:"FrameworkType"` + + // Represents the maximum number of results on a page or for an API request + // call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token that's used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation. @@ -12011,7 +13839,7 @@ type GetSettingsInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetSettingsInput) String() string { +func (s ListAssessmentFrameworksInput) String() string { return awsutil.Prettify(s) } @@ -12020,18 +13848,21 @@ func (s GetSettingsInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetSettingsInput) GoString() string { +func (s ListAssessmentFrameworksInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetSettingsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetSettingsInput"} - if s.Attribute == nil { - invalidParams.Add(request.NewErrParamRequired("Attribute")) +func (s *ListAssessmentFrameworksInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAssessmentFrameworksInput"} + if s.FrameworkType == nil { + invalidParams.Add(request.NewErrParamRequired("FrameworkType")) } - if s.Attribute != nil && len(*s.Attribute) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Attribute", 1)) + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } if invalidParams.Len() > 0 { @@ -12040,17 +13871,32 @@ func (s *GetSettingsInput) Validate() error { return nil } -// SetAttribute sets the Attribute field's value. -func (s *GetSettingsInput) SetAttribute(v string) *GetSettingsInput { - s.Attribute = &v +// SetFrameworkType sets the FrameworkType field's value. +func (s *ListAssessmentFrameworksInput) SetFrameworkType(v string) *ListAssessmentFrameworksInput { + s.FrameworkType = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListAssessmentFrameworksInput) SetMaxResults(v int64) *ListAssessmentFrameworksInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListAssessmentFrameworksInput) SetNextToken(v string) *ListAssessmentFrameworksInput { + s.NextToken = &v return s } -type GetSettingsOutput struct { +type ListAssessmentFrameworksOutput struct { _ struct{} `type:"structure"` - // The settings object that holds all supported Audit Manager settings. - Settings *Settings `locationName:"settings" type:"structure"` + // The list of metadata objects for the framework. + FrameworkMetadataList []*AssessmentFrameworkMetadata `locationName:"frameworkMetadataList" type:"list"` + + // The pagination token that's used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation. @@ -12058,7 +13904,7 @@ type GetSettingsOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetSettingsOutput) String() string { +func (s ListAssessmentFrameworksOutput) String() string { return awsutil.Prettify(s) } @@ -12067,23 +13913,31 @@ func (s GetSettingsOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s GetSettingsOutput) GoString() string { +func (s ListAssessmentFrameworksOutput) GoString() string { return s.String() } -// SetSettings sets the Settings field's value. -func (s *GetSettingsOutput) SetSettings(v *Settings) *GetSettingsOutput { - s.Settings = v +// SetFrameworkMetadataList sets the FrameworkMetadataList field's value. +func (s *ListAssessmentFrameworksOutput) SetFrameworkMetadataList(v []*AssessmentFrameworkMetadata) *ListAssessmentFrameworksOutput { + s.FrameworkMetadataList = v return s } -// An internal service error occurred during the processing of your request. -// Try again later. -type InternalServerException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +// SetNextToken sets the NextToken field's value. +func (s *ListAssessmentFrameworksOutput) SetNextToken(v string) *ListAssessmentFrameworksOutput { + s.NextToken = &v + return s +} - Message_ *string `locationName:"message" type:"string"` +type ListAssessmentReportsInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // Represents the maximum number of results on a page or for an API request + // call. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The pagination token that's used to fetch the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` } // String returns the string representation. @@ -12091,7 +13945,7 @@ type InternalServerException struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s InternalServerException) String() string { +func (s ListAssessmentReportsInput) String() string { return awsutil.Prettify(s) } @@ -12100,49 +13954,79 @@ func (s InternalServerException) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s InternalServerException) GoString() string { +func (s ListAssessmentReportsInput) GoString() string { return s.String() } -func newErrorInternalServerException(v protocol.ResponseMetadata) error { - return &InternalServerException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListAssessmentReportsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAssessmentReportsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams } + return nil } -// Code returns the exception type name. -func (s *InternalServerException) Code() string { - return "InternalServerException" +// SetMaxResults sets the MaxResults field's value. +func (s *ListAssessmentReportsInput) SetMaxResults(v int64) *ListAssessmentReportsInput { + s.MaxResults = &v + return s } -// Message returns the exception's message. -func (s *InternalServerException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" +// SetNextToken sets the NextToken field's value. +func (s *ListAssessmentReportsInput) SetNextToken(v string) *ListAssessmentReportsInput { + s.NextToken = &v + return s } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *InternalServerException) OrigErr() error { - return nil +type ListAssessmentReportsOutput struct { + _ struct{} `type:"structure"` + + // The list of assessment reports that the ListAssessmentReports API returned. + AssessmentReports []*AssessmentReportMetadata `locationName:"assessmentReports" type:"list"` + + // The pagination token that's used to fetch the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` } -func (s *InternalServerException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAssessmentReportsOutput) String() string { + return awsutil.Prettify(s) } -// Status code returns the HTTP status code for the request's response error. -func (s *InternalServerException) StatusCode() int { - return s.RespMetadata.StatusCode +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListAssessmentReportsOutput) GoString() string { + return s.String() } -// RequestID returns the service's response RequestID for request. -func (s *InternalServerException) RequestID() string { - return s.RespMetadata.RequestID +// SetAssessmentReports sets the AssessmentReports field's value. +func (s *ListAssessmentReportsOutput) SetAssessmentReports(v []*AssessmentReportMetadata) *ListAssessmentReportsOutput { + s.AssessmentReports = v + return s } -type ListAssessmentFrameworkShareRequestsInput struct { +// SetNextToken sets the NextToken field's value. +func (s *ListAssessmentReportsOutput) SetNextToken(v string) *ListAssessmentReportsOutput { + s.NextToken = &v + return s +} + +type ListAssessmentsInput struct { _ struct{} `type:"structure" nopayload:"true"` // Represents the maximum number of results on a page or for an API request @@ -12152,10 +14036,8 @@ type ListAssessmentFrameworkShareRequestsInput struct { // The pagination token that's used to fetch the next set of results. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` - // Specifies whether the share request is a sent request or a received request. - // - // RequestType is a required field - RequestType *string `location:"querystring" locationName:"requestType" type:"string" required:"true" enum:"ShareRequestType"` + // The current status of the assessment. + Status *string `location:"querystring" locationName:"status" type:"string" enum:"AssessmentStatus"` } // String returns the string representation. @@ -12163,7 +14045,7 @@ type ListAssessmentFrameworkShareRequestsInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentFrameworkShareRequestsInput) String() string { +func (s ListAssessmentsInput) String() string { return awsutil.Prettify(s) } @@ -12172,22 +14054,19 @@ func (s ListAssessmentFrameworkShareRequestsInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentFrameworkShareRequestsInput) GoString() string { +func (s ListAssessmentsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListAssessmentFrameworkShareRequestsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListAssessmentFrameworkShareRequestsInput"} +func (s *ListAssessmentsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListAssessmentsInput"} if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } if s.NextToken != nil && len(*s.NextToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } - if s.RequestType == nil { - invalidParams.Add(request.NewErrParamRequired("RequestType")) - } if invalidParams.Len() > 0 { return invalidParams @@ -12196,29 +14075,28 @@ func (s *ListAssessmentFrameworkShareRequestsInput) Validate() error { } // SetMaxResults sets the MaxResults field's value. -func (s *ListAssessmentFrameworkShareRequestsInput) SetMaxResults(v int64) *ListAssessmentFrameworkShareRequestsInput { +func (s *ListAssessmentsInput) SetMaxResults(v int64) *ListAssessmentsInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListAssessmentFrameworkShareRequestsInput) SetNextToken(v string) *ListAssessmentFrameworkShareRequestsInput { +func (s *ListAssessmentsInput) SetNextToken(v string) *ListAssessmentsInput { s.NextToken = &v return s } -// SetRequestType sets the RequestType field's value. -func (s *ListAssessmentFrameworkShareRequestsInput) SetRequestType(v string) *ListAssessmentFrameworkShareRequestsInput { - s.RequestType = &v +// SetStatus sets the Status field's value. +func (s *ListAssessmentsInput) SetStatus(v string) *ListAssessmentsInput { + s.Status = &v return s } -type ListAssessmentFrameworkShareRequestsOutput struct { +type ListAssessmentsOutput struct { _ struct{} `type:"structure"` - // The list of share requests that the ListAssessmentFrameworkShareRequests - // API returned. - AssessmentFrameworkShareRequests []*AssessmentFrameworkShareRequest `locationName:"assessmentFrameworkShareRequests" type:"list"` + // The metadata that's associated with the assessment. + AssessmentMetadata []*AssessmentMetadataItem `locationName:"assessmentMetadata" type:"list"` // The pagination token that's used to fetch the next set of results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` @@ -12229,7 +14107,7 @@ type ListAssessmentFrameworkShareRequestsOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentFrameworkShareRequestsOutput) String() string { +func (s ListAssessmentsOutput) String() string { return awsutil.Prettify(s) } @@ -12238,29 +14116,29 @@ func (s ListAssessmentFrameworkShareRequestsOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentFrameworkShareRequestsOutput) GoString() string { +func (s ListAssessmentsOutput) GoString() string { return s.String() } -// SetAssessmentFrameworkShareRequests sets the AssessmentFrameworkShareRequests field's value. -func (s *ListAssessmentFrameworkShareRequestsOutput) SetAssessmentFrameworkShareRequests(v []*AssessmentFrameworkShareRequest) *ListAssessmentFrameworkShareRequestsOutput { - s.AssessmentFrameworkShareRequests = v +// SetAssessmentMetadata sets the AssessmentMetadata field's value. +func (s *ListAssessmentsOutput) SetAssessmentMetadata(v []*AssessmentMetadataItem) *ListAssessmentsOutput { + s.AssessmentMetadata = v return s } // SetNextToken sets the NextToken field's value. -func (s *ListAssessmentFrameworkShareRequestsOutput) SetNextToken(v string) *ListAssessmentFrameworkShareRequestsOutput { +func (s *ListAssessmentsOutput) SetNextToken(v string) *ListAssessmentsOutput { s.NextToken = &v return s } -type ListAssessmentFrameworksInput struct { +type ListControlDomainInsightsByAssessmentInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The type of framework, such as a standard framework or a custom framework. + // The unique identifier for the active assessment. // - // FrameworkType is a required field - FrameworkType *string `location:"querystring" locationName:"frameworkType" type:"string" required:"true" enum:"FrameworkType"` + // AssessmentId is a required field + AssessmentId *string `location:"querystring" locationName:"assessmentId" min:"36" type:"string" required:"true"` // Represents the maximum number of results on a page or for an API request // call. @@ -12275,7 +14153,7 @@ type ListAssessmentFrameworksInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentFrameworksInput) String() string { +func (s ListControlDomainInsightsByAssessmentInput) String() string { return awsutil.Prettify(s) } @@ -12284,15 +14162,18 @@ func (s ListAssessmentFrameworksInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentFrameworksInput) GoString() string { +func (s ListControlDomainInsightsByAssessmentInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListAssessmentFrameworksInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListAssessmentFrameworksInput"} - if s.FrameworkType == nil { - invalidParams.Add(request.NewErrParamRequired("FrameworkType")) +func (s *ListControlDomainInsightsByAssessmentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListControlDomainInsightsByAssessmentInput"} + if s.AssessmentId == nil { + invalidParams.Add(request.NewErrParamRequired("AssessmentId")) + } + if s.AssessmentId != nil && len(*s.AssessmentId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("AssessmentId", 36)) } if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) @@ -12307,29 +14188,30 @@ func (s *ListAssessmentFrameworksInput) Validate() error { return nil } -// SetFrameworkType sets the FrameworkType field's value. -func (s *ListAssessmentFrameworksInput) SetFrameworkType(v string) *ListAssessmentFrameworksInput { - s.FrameworkType = &v +// SetAssessmentId sets the AssessmentId field's value. +func (s *ListControlDomainInsightsByAssessmentInput) SetAssessmentId(v string) *ListControlDomainInsightsByAssessmentInput { + s.AssessmentId = &v return s } // SetMaxResults sets the MaxResults field's value. -func (s *ListAssessmentFrameworksInput) SetMaxResults(v int64) *ListAssessmentFrameworksInput { +func (s *ListControlDomainInsightsByAssessmentInput) SetMaxResults(v int64) *ListControlDomainInsightsByAssessmentInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListAssessmentFrameworksInput) SetNextToken(v string) *ListAssessmentFrameworksInput { +func (s *ListControlDomainInsightsByAssessmentInput) SetNextToken(v string) *ListControlDomainInsightsByAssessmentInput { s.NextToken = &v return s } -type ListAssessmentFrameworksOutput struct { +type ListControlDomainInsightsByAssessmentOutput struct { _ struct{} `type:"structure"` - // The list of metadata objects for the framework. - FrameworkMetadataList []*AssessmentFrameworkMetadata `locationName:"frameworkMetadataList" type:"list"` + // The control domain analytics data that the ListControlDomainInsightsByAssessment + // API returned. + ControlDomainInsights []*ControlDomainInsights `locationName:"controlDomainInsights" type:"list"` // The pagination token that's used to fetch the next set of results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` @@ -12340,7 +14222,7 @@ type ListAssessmentFrameworksOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentFrameworksOutput) String() string { +func (s ListControlDomainInsightsByAssessmentOutput) String() string { return awsutil.Prettify(s) } @@ -12349,23 +14231,23 @@ func (s ListAssessmentFrameworksOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentFrameworksOutput) GoString() string { +func (s ListControlDomainInsightsByAssessmentOutput) GoString() string { return s.String() } -// SetFrameworkMetadataList sets the FrameworkMetadataList field's value. -func (s *ListAssessmentFrameworksOutput) SetFrameworkMetadataList(v []*AssessmentFrameworkMetadata) *ListAssessmentFrameworksOutput { - s.FrameworkMetadataList = v +// SetControlDomainInsights sets the ControlDomainInsights field's value. +func (s *ListControlDomainInsightsByAssessmentOutput) SetControlDomainInsights(v []*ControlDomainInsights) *ListControlDomainInsightsByAssessmentOutput { + s.ControlDomainInsights = v return s } // SetNextToken sets the NextToken field's value. -func (s *ListAssessmentFrameworksOutput) SetNextToken(v string) *ListAssessmentFrameworksOutput { +func (s *ListControlDomainInsightsByAssessmentOutput) SetNextToken(v string) *ListControlDomainInsightsByAssessmentOutput { s.NextToken = &v return s } -type ListAssessmentReportsInput struct { +type ListControlDomainInsightsInput struct { _ struct{} `type:"structure" nopayload:"true"` // Represents the maximum number of results on a page or for an API request @@ -12381,7 +14263,7 @@ type ListAssessmentReportsInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentReportsInput) String() string { +func (s ListControlDomainInsightsInput) String() string { return awsutil.Prettify(s) } @@ -12390,13 +14272,13 @@ func (s ListAssessmentReportsInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentReportsInput) GoString() string { +func (s ListControlDomainInsightsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListAssessmentReportsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListAssessmentReportsInput"} +func (s *ListControlDomainInsightsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListControlDomainInsightsInput"} if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -12411,22 +14293,23 @@ func (s *ListAssessmentReportsInput) Validate() error { } // SetMaxResults sets the MaxResults field's value. -func (s *ListAssessmentReportsInput) SetMaxResults(v int64) *ListAssessmentReportsInput { +func (s *ListControlDomainInsightsInput) SetMaxResults(v int64) *ListControlDomainInsightsInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListAssessmentReportsInput) SetNextToken(v string) *ListAssessmentReportsInput { +func (s *ListControlDomainInsightsInput) SetNextToken(v string) *ListControlDomainInsightsInput { s.NextToken = &v return s } -type ListAssessmentReportsOutput struct { +type ListControlDomainInsightsOutput struct { _ struct{} `type:"structure"` - // The list of assessment reports that the ListAssessmentReports API returned. - AssessmentReports []*AssessmentReportMetadata `locationName:"assessmentReports" type:"list"` + // The control domain analytics data that the ListControlDomainInsights API + // returned. + ControlDomainInsights []*ControlDomainInsights `locationName:"controlDomainInsights" type:"list"` // The pagination token that's used to fetch the next set of results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` @@ -12437,7 +14320,7 @@ type ListAssessmentReportsOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentReportsOutput) String() string { +func (s ListControlDomainInsightsOutput) String() string { return awsutil.Prettify(s) } @@ -12446,25 +14329,30 @@ func (s ListAssessmentReportsOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentReportsOutput) GoString() string { +func (s ListControlDomainInsightsOutput) GoString() string { return s.String() } -// SetAssessmentReports sets the AssessmentReports field's value. -func (s *ListAssessmentReportsOutput) SetAssessmentReports(v []*AssessmentReportMetadata) *ListAssessmentReportsOutput { - s.AssessmentReports = v +// SetControlDomainInsights sets the ControlDomainInsights field's value. +func (s *ListControlDomainInsightsOutput) SetControlDomainInsights(v []*ControlDomainInsights) *ListControlDomainInsightsOutput { + s.ControlDomainInsights = v return s } // SetNextToken sets the NextToken field's value. -func (s *ListAssessmentReportsOutput) SetNextToken(v string) *ListAssessmentReportsOutput { +func (s *ListControlDomainInsightsOutput) SetNextToken(v string) *ListControlDomainInsightsOutput { s.NextToken = &v return s } -type ListAssessmentsInput struct { +type ListControlInsightsByControlDomainInput struct { _ struct{} `type:"structure" nopayload:"true"` + // The unique identifier for the control domain. + // + // ControlDomainId is a required field + ControlDomainId *string `location:"querystring" locationName:"controlDomainId" min:"36" type:"string" required:"true"` + // Represents the maximum number of results on a page or for an API request // call. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` @@ -12478,7 +14366,7 @@ type ListAssessmentsInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentsInput) String() string { +func (s ListControlInsightsByControlDomainInput) String() string { return awsutil.Prettify(s) } @@ -12487,13 +14375,19 @@ func (s ListAssessmentsInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentsInput) GoString() string { +func (s ListControlInsightsByControlDomainInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListAssessmentsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListAssessmentsInput"} +func (s *ListControlInsightsByControlDomainInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListControlInsightsByControlDomainInput"} + if s.ControlDomainId == nil { + invalidParams.Add(request.NewErrParamRequired("ControlDomainId")) + } + if s.ControlDomainId != nil && len(*s.ControlDomainId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("ControlDomainId", 36)) + } if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -12507,23 +14401,30 @@ func (s *ListAssessmentsInput) Validate() error { return nil } +// SetControlDomainId sets the ControlDomainId field's value. +func (s *ListControlInsightsByControlDomainInput) SetControlDomainId(v string) *ListControlInsightsByControlDomainInput { + s.ControlDomainId = &v + return s +} + // SetMaxResults sets the MaxResults field's value. -func (s *ListAssessmentsInput) SetMaxResults(v int64) *ListAssessmentsInput { +func (s *ListControlInsightsByControlDomainInput) SetMaxResults(v int64) *ListControlInsightsByControlDomainInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListAssessmentsInput) SetNextToken(v string) *ListAssessmentsInput { +func (s *ListControlInsightsByControlDomainInput) SetNextToken(v string) *ListControlInsightsByControlDomainInput { s.NextToken = &v return s } -type ListAssessmentsOutput struct { +type ListControlInsightsByControlDomainOutput struct { _ struct{} `type:"structure"` - // The metadata that's associated with the assessment. - AssessmentMetadata []*AssessmentMetadataItem `locationName:"assessmentMetadata" type:"list"` + // The control analytics data that the ListControlInsightsByControlDomain API + // returned. + ControlInsightsMetadata []*ControlInsightsMetadataItem `locationName:"controlInsightsMetadata" type:"list"` // The pagination token that's used to fetch the next set of results. NextToken *string `locationName:"nextToken" min:"1" type:"string"` @@ -12534,7 +14435,7 @@ type ListAssessmentsOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentsOutput) String() string { +func (s ListControlInsightsByControlDomainOutput) String() string { return awsutil.Prettify(s) } @@ -12543,18 +14444,18 @@ func (s ListAssessmentsOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListAssessmentsOutput) GoString() string { +func (s ListControlInsightsByControlDomainOutput) GoString() string { return s.String() } -// SetAssessmentMetadata sets the AssessmentMetadata field's value. -func (s *ListAssessmentsOutput) SetAssessmentMetadata(v []*AssessmentMetadataItem) *ListAssessmentsOutput { - s.AssessmentMetadata = v +// SetControlInsightsMetadata sets the ControlInsightsMetadata field's value. +func (s *ListControlInsightsByControlDomainOutput) SetControlInsightsMetadata(v []*ControlInsightsMetadataItem) *ListControlInsightsByControlDomainOutput { + s.ControlInsightsMetadata = v return s } // SetNextToken sets the NextToken field's value. -func (s *ListAssessmentsOutput) SetNextToken(v string) *ListAssessmentsOutput { +func (s *ListControlInsightsByControlDomainOutput) SetNextToken(v string) *ListControlInsightsByControlDomainOutput { s.NextToken = &v return s } @@ -14047,7 +15948,7 @@ func (s UntagResourceOutput) GoString() string { type UpdateAssessmentControlInput struct { _ struct{} `type:"structure"` - // The identifier for the assessment. + // The unique identifier for the assessment. // // AssessmentId is a required field AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` @@ -14055,12 +15956,12 @@ type UpdateAssessmentControlInput struct { // The comment body text for the control. CommentBody *string `locationName:"commentBody" type:"string"` - // The identifier for the control. + // The unique identifier for the control. // // ControlId is a required field ControlId *string `location:"uri" locationName:"controlId" min:"36" type:"string" required:"true"` - // The identifier for the control set. + // The unique identifier for the control set. // // ControlSetId is a required field ControlSetId *string `location:"uri" locationName:"controlSetId" min:"1" type:"string" required:"true"` @@ -14180,7 +16081,7 @@ func (s *UpdateAssessmentControlOutput) SetControl(v *AssessmentControl) *Update type UpdateAssessmentControlSetStatusInput struct { _ struct{} `type:"structure"` - // The identifier for the assessment. + // The unique identifier for the assessment. // // AssessmentId is a required field AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` @@ -14190,7 +16091,7 @@ type UpdateAssessmentControlSetStatusInput struct { // Comment is a required field Comment *string `locationName:"comment" type:"string" required:"true"` - // The identifier for the control set. + // The unique identifier for the control set. // // ControlSetId is a required field ControlSetId *string `location:"uri" locationName:"controlSetId" type:"string" required:"true"` @@ -14403,7 +16304,7 @@ type UpdateAssessmentFrameworkInput struct { // The description of the updated framework. Description *string `locationName:"description" min:"1" type:"string"` - // The identifier for the framework. + // The unique identifier for the framework. // // FrameworkId is a required field FrameworkId *string `location:"uri" locationName:"frameworkId" min:"36" type:"string" required:"true"` @@ -14646,7 +16547,7 @@ type UpdateAssessmentInput struct { // The description of the assessment. AssessmentDescription *string `locationName:"assessmentDescription" type:"string"` - // The identifier for the assessment. + // The unique identifier for the assessment. // // AssessmentId is a required field AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` @@ -14798,7 +16699,7 @@ func (s *UpdateAssessmentOutput) SetAssessment(v *Assessment) *UpdateAssessmentO type UpdateAssessmentStatusInput struct { _ struct{} `type:"structure"` - // The identifier for the assessment. + // The unique identifier for the assessment. // // AssessmentId is a required field AssessmentId *string `location:"uri" locationName:"assessmentId" min:"36" type:"string" required:"true"` diff --git a/service/auditmanager/auditmanageriface/interface.go b/service/auditmanager/auditmanageriface/interface.go index d13038cc0d..1483af603d 100644 --- a/service/auditmanager/auditmanageriface/interface.go +++ b/service/auditmanager/auditmanageriface/interface.go @@ -195,6 +195,14 @@ type AuditManagerAPI interface { GetEvidenceFoldersByAssessmentControlPages(*auditmanager.GetEvidenceFoldersByAssessmentControlInput, func(*auditmanager.GetEvidenceFoldersByAssessmentControlOutput, bool) bool) error GetEvidenceFoldersByAssessmentControlPagesWithContext(aws.Context, *auditmanager.GetEvidenceFoldersByAssessmentControlInput, func(*auditmanager.GetEvidenceFoldersByAssessmentControlOutput, bool) bool, ...request.Option) error + GetInsights(*auditmanager.GetInsightsInput) (*auditmanager.GetInsightsOutput, error) + GetInsightsWithContext(aws.Context, *auditmanager.GetInsightsInput, ...request.Option) (*auditmanager.GetInsightsOutput, error) + GetInsightsRequest(*auditmanager.GetInsightsInput) (*request.Request, *auditmanager.GetInsightsOutput) + + GetInsightsByAssessment(*auditmanager.GetInsightsByAssessmentInput) (*auditmanager.GetInsightsByAssessmentOutput, error) + GetInsightsByAssessmentWithContext(aws.Context, *auditmanager.GetInsightsByAssessmentInput, ...request.Option) (*auditmanager.GetInsightsByAssessmentOutput, error) + GetInsightsByAssessmentRequest(*auditmanager.GetInsightsByAssessmentInput) (*request.Request, *auditmanager.GetInsightsByAssessmentOutput) + GetOrganizationAdminAccount(*auditmanager.GetOrganizationAdminAccountInput) (*auditmanager.GetOrganizationAdminAccountOutput, error) GetOrganizationAdminAccountWithContext(aws.Context, *auditmanager.GetOrganizationAdminAccountInput, ...request.Option) (*auditmanager.GetOrganizationAdminAccountOutput, error) GetOrganizationAdminAccountRequest(*auditmanager.GetOrganizationAdminAccountInput) (*request.Request, *auditmanager.GetOrganizationAdminAccountOutput) @@ -207,6 +215,13 @@ type AuditManagerAPI interface { GetSettingsWithContext(aws.Context, *auditmanager.GetSettingsInput, ...request.Option) (*auditmanager.GetSettingsOutput, error) GetSettingsRequest(*auditmanager.GetSettingsInput) (*request.Request, *auditmanager.GetSettingsOutput) + ListAssessmentControlInsightsByControlDomain(*auditmanager.ListAssessmentControlInsightsByControlDomainInput) (*auditmanager.ListAssessmentControlInsightsByControlDomainOutput, error) + ListAssessmentControlInsightsByControlDomainWithContext(aws.Context, *auditmanager.ListAssessmentControlInsightsByControlDomainInput, ...request.Option) (*auditmanager.ListAssessmentControlInsightsByControlDomainOutput, error) + ListAssessmentControlInsightsByControlDomainRequest(*auditmanager.ListAssessmentControlInsightsByControlDomainInput) (*request.Request, *auditmanager.ListAssessmentControlInsightsByControlDomainOutput) + + ListAssessmentControlInsightsByControlDomainPages(*auditmanager.ListAssessmentControlInsightsByControlDomainInput, func(*auditmanager.ListAssessmentControlInsightsByControlDomainOutput, bool) bool) error + ListAssessmentControlInsightsByControlDomainPagesWithContext(aws.Context, *auditmanager.ListAssessmentControlInsightsByControlDomainInput, func(*auditmanager.ListAssessmentControlInsightsByControlDomainOutput, bool) bool, ...request.Option) error + ListAssessmentFrameworkShareRequests(*auditmanager.ListAssessmentFrameworkShareRequestsInput) (*auditmanager.ListAssessmentFrameworkShareRequestsOutput, error) ListAssessmentFrameworkShareRequestsWithContext(aws.Context, *auditmanager.ListAssessmentFrameworkShareRequestsInput, ...request.Option) (*auditmanager.ListAssessmentFrameworkShareRequestsOutput, error) ListAssessmentFrameworkShareRequestsRequest(*auditmanager.ListAssessmentFrameworkShareRequestsInput) (*request.Request, *auditmanager.ListAssessmentFrameworkShareRequestsOutput) @@ -235,6 +250,27 @@ type AuditManagerAPI interface { ListAssessmentsPages(*auditmanager.ListAssessmentsInput, func(*auditmanager.ListAssessmentsOutput, bool) bool) error ListAssessmentsPagesWithContext(aws.Context, *auditmanager.ListAssessmentsInput, func(*auditmanager.ListAssessmentsOutput, bool) bool, ...request.Option) error + ListControlDomainInsights(*auditmanager.ListControlDomainInsightsInput) (*auditmanager.ListControlDomainInsightsOutput, error) + ListControlDomainInsightsWithContext(aws.Context, *auditmanager.ListControlDomainInsightsInput, ...request.Option) (*auditmanager.ListControlDomainInsightsOutput, error) + ListControlDomainInsightsRequest(*auditmanager.ListControlDomainInsightsInput) (*request.Request, *auditmanager.ListControlDomainInsightsOutput) + + ListControlDomainInsightsPages(*auditmanager.ListControlDomainInsightsInput, func(*auditmanager.ListControlDomainInsightsOutput, bool) bool) error + ListControlDomainInsightsPagesWithContext(aws.Context, *auditmanager.ListControlDomainInsightsInput, func(*auditmanager.ListControlDomainInsightsOutput, bool) bool, ...request.Option) error + + ListControlDomainInsightsByAssessment(*auditmanager.ListControlDomainInsightsByAssessmentInput) (*auditmanager.ListControlDomainInsightsByAssessmentOutput, error) + ListControlDomainInsightsByAssessmentWithContext(aws.Context, *auditmanager.ListControlDomainInsightsByAssessmentInput, ...request.Option) (*auditmanager.ListControlDomainInsightsByAssessmentOutput, error) + ListControlDomainInsightsByAssessmentRequest(*auditmanager.ListControlDomainInsightsByAssessmentInput) (*request.Request, *auditmanager.ListControlDomainInsightsByAssessmentOutput) + + ListControlDomainInsightsByAssessmentPages(*auditmanager.ListControlDomainInsightsByAssessmentInput, func(*auditmanager.ListControlDomainInsightsByAssessmentOutput, bool) bool) error + ListControlDomainInsightsByAssessmentPagesWithContext(aws.Context, *auditmanager.ListControlDomainInsightsByAssessmentInput, func(*auditmanager.ListControlDomainInsightsByAssessmentOutput, bool) bool, ...request.Option) error + + ListControlInsightsByControlDomain(*auditmanager.ListControlInsightsByControlDomainInput) (*auditmanager.ListControlInsightsByControlDomainOutput, error) + ListControlInsightsByControlDomainWithContext(aws.Context, *auditmanager.ListControlInsightsByControlDomainInput, ...request.Option) (*auditmanager.ListControlInsightsByControlDomainOutput, error) + ListControlInsightsByControlDomainRequest(*auditmanager.ListControlInsightsByControlDomainInput) (*request.Request, *auditmanager.ListControlInsightsByControlDomainOutput) + + ListControlInsightsByControlDomainPages(*auditmanager.ListControlInsightsByControlDomainInput, func(*auditmanager.ListControlInsightsByControlDomainOutput, bool) bool) error + ListControlInsightsByControlDomainPagesWithContext(aws.Context, *auditmanager.ListControlInsightsByControlDomainInput, func(*auditmanager.ListControlInsightsByControlDomainOutput, bool) bool, ...request.Option) error + ListControls(*auditmanager.ListControlsInput) (*auditmanager.ListControlsOutput, error) ListControlsWithContext(aws.Context, *auditmanager.ListControlsInput, ...request.Option) (*auditmanager.ListControlsOutput, error) ListControlsRequest(*auditmanager.ListControlsInput) (*request.Request, *auditmanager.ListControlsOutput) diff --git a/service/chime/api.go b/service/chime/api.go index 13f99953f7..80f51733a5 100644 --- a/service/chime/api.go +++ b/service/chime/api.go @@ -31159,6 +31159,10 @@ func (s *EmergencyCallingConfiguration) SetDNIS(v []*DNISEmergencyCallingConfigu type EngineTranscribeMedicalSettings struct { _ struct{} `type:"structure"` + // Set this field to PHI to identify personal health information in the transcription + // output. + ContentIdentificationType *string `type:"string" enum:"TranscribeMedicalContentIdentificationType"` + // The language code specified for the Amazon Transcribe Medical engine. // // LanguageCode is a required field @@ -31219,6 +31223,12 @@ func (s *EngineTranscribeMedicalSettings) Validate() error { return nil } +// SetContentIdentificationType sets the ContentIdentificationType field's value. +func (s *EngineTranscribeMedicalSettings) SetContentIdentificationType(v string) *EngineTranscribeMedicalSettings { + s.ContentIdentificationType = &v + return s +} + // SetLanguageCode sets the LanguageCode field's value. func (s *EngineTranscribeMedicalSettings) SetLanguageCode(v string) *EngineTranscribeMedicalSettings { s.LanguageCode = &v @@ -31253,11 +31263,43 @@ func (s *EngineTranscribeMedicalSettings) SetVocabularyName(v string) *EngineTra type EngineTranscribeSettings struct { _ struct{} `type:"structure"` + // Set this field to PII to identify personal health information in the transcription + // output. + ContentIdentificationType *string `type:"string" enum:"TranscribeContentIdentificationType"` + + // Set this field to PII to redact personally identifiable information in the + // transcription output. Content redaction is performed only upon complete transcription + // of the audio segments. + ContentRedactionType *string `type:"string" enum:"TranscribeContentRedactionType"` + + // Generates partial transcription results that are less likely to change as + // meeting attendees speak. It does so by only allowing the last few words from + // the partial results to change. + EnablePartialResultsStabilization *bool `type:"boolean"` + // The language code specified for the Amazon Transcribe engine. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"TranscribeLanguageCode"` + // The name of the language model used during transcription. + LanguageModelName *string `min:"1" type:"string"` + + // The stabity level of a partial results transcription. Determines how stable + // you want the transcription results to be. A higher level means the transcription + // results are less likely to change. + PartialResultsStability *string `type:"string" enum:"TranscribePartialResultsStability"` + + // Lists the PII entity types you want to identify or redact. To specify entity + // types, you must enable ContentIdentificationType or ContentRedactionType. + // + // PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER, + // BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, + // PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL. + // + // PiiEntityTypes is an optional parameter with a default value of ALL. + PiiEntityTypes *string `min:"1" type:"string"` + // The AWS Region passed to Amazon Transcribe. If you don't specify a Region, // Amazon Chime uses the meeting's Region. Region *string `type:"string" enum:"TranscribeRegion"` @@ -31296,6 +31338,12 @@ func (s *EngineTranscribeSettings) Validate() error { if s.LanguageCode == nil { invalidParams.Add(request.NewErrParamRequired("LanguageCode")) } + if s.LanguageModelName != nil && len(*s.LanguageModelName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LanguageModelName", 1)) + } + if s.PiiEntityTypes != nil && len(*s.PiiEntityTypes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PiiEntityTypes", 1)) + } if invalidParams.Len() > 0 { return invalidParams @@ -31303,12 +31351,48 @@ func (s *EngineTranscribeSettings) Validate() error { return nil } +// SetContentIdentificationType sets the ContentIdentificationType field's value. +func (s *EngineTranscribeSettings) SetContentIdentificationType(v string) *EngineTranscribeSettings { + s.ContentIdentificationType = &v + return s +} + +// SetContentRedactionType sets the ContentRedactionType field's value. +func (s *EngineTranscribeSettings) SetContentRedactionType(v string) *EngineTranscribeSettings { + s.ContentRedactionType = &v + return s +} + +// SetEnablePartialResultsStabilization sets the EnablePartialResultsStabilization field's value. +func (s *EngineTranscribeSettings) SetEnablePartialResultsStabilization(v bool) *EngineTranscribeSettings { + s.EnablePartialResultsStabilization = &v + return s +} + // SetLanguageCode sets the LanguageCode field's value. func (s *EngineTranscribeSettings) SetLanguageCode(v string) *EngineTranscribeSettings { s.LanguageCode = &v return s } +// SetLanguageModelName sets the LanguageModelName field's value. +func (s *EngineTranscribeSettings) SetLanguageModelName(v string) *EngineTranscribeSettings { + s.LanguageModelName = &v + return s +} + +// SetPartialResultsStability sets the PartialResultsStability field's value. +func (s *EngineTranscribeSettings) SetPartialResultsStability(v string) *EngineTranscribeSettings { + s.PartialResultsStability = &v + return s +} + +// SetPiiEntityTypes sets the PiiEntityTypes field's value. +func (s *EngineTranscribeSettings) SetPiiEntityTypes(v string) *EngineTranscribeSettings { + s.PiiEntityTypes = &v + return s +} + // SetRegion sets the Region field's value. func (s *EngineTranscribeSettings) SetRegion(v string) *EngineTranscribeSettings { s.Region = &v @@ -47763,6 +47847,30 @@ func SortOrder_Values() []string { } } +const ( + // TranscribeContentIdentificationTypePii is a TranscribeContentIdentificationType enum value + TranscribeContentIdentificationTypePii = "PII" +) + +// TranscribeContentIdentificationType_Values returns all elements of the TranscribeContentIdentificationType enum +func TranscribeContentIdentificationType_Values() []string { + return []string{ + TranscribeContentIdentificationTypePii, + } +} + +const ( + // TranscribeContentRedactionTypePii is a TranscribeContentRedactionType enum value + TranscribeContentRedactionTypePii = "PII" +) + +// TranscribeContentRedactionType_Values returns all elements of the TranscribeContentRedactionType enum +func TranscribeContentRedactionType_Values() []string { + return []string{ + TranscribeContentRedactionTypePii, + } +} + const ( // TranscribeLanguageCodeEnUs is a TranscribeLanguageCode enum value TranscribeLanguageCodeEnUs = "en-US" @@ -47819,6 +47927,18 @@ func TranscribeLanguageCode_Values() []string { } } +const ( + // TranscribeMedicalContentIdentificationTypePhi is a TranscribeMedicalContentIdentificationType enum value + TranscribeMedicalContentIdentificationTypePhi = "PHI" +) + +// TranscribeMedicalContentIdentificationType_Values returns all elements of the TranscribeMedicalContentIdentificationType enum +func TranscribeMedicalContentIdentificationType_Values() []string { + return []string{ + TranscribeMedicalContentIdentificationTypePhi, + } +} + const ( // TranscribeMedicalLanguageCodeEnUs is a TranscribeMedicalLanguageCode enum value TranscribeMedicalLanguageCodeEnUs = "en-US" @@ -47915,6 +48035,26 @@ func TranscribeMedicalType_Values() []string { } } +const ( + // TranscribePartialResultsStabilityLow is a TranscribePartialResultsStability enum value + TranscribePartialResultsStabilityLow = "low" + + // TranscribePartialResultsStabilityMedium is a TranscribePartialResultsStability enum value + TranscribePartialResultsStabilityMedium = "medium" + + // TranscribePartialResultsStabilityHigh is a TranscribePartialResultsStability enum value + TranscribePartialResultsStabilityHigh = "high" +) + +// TranscribePartialResultsStability_Values returns all elements of the TranscribePartialResultsStability enum +func TranscribePartialResultsStability_Values() []string { + return []string{ + TranscribePartialResultsStabilityLow, + TranscribePartialResultsStabilityMedium, + TranscribePartialResultsStabilityHigh, + } +} + const ( // TranscribeRegionUsEast2 is a TranscribeRegion enum value TranscribeRegionUsEast2 = "us-east-2" diff --git a/service/chime/doc.go b/service/chime/doc.go index 0952e11043..1389c9ddfa 100644 --- a/service/chime/doc.go +++ b/service/chime/doc.go @@ -7,10 +7,11 @@ // developers to perform key tasks, such as creating and managing Amazon Chime // accounts, users, and Voice Connectors. This guide provides detailed information // about the Amazon Chime API, including operations, types, inputs and outputs, -// and error codes. It also includes some server-side API actions to use with -// the Amazon Chime SDK. For more information about the Amazon Chime SDK, see -// Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) -// in the Amazon Chime Developer Guide. +// and error codes. It also includes API actions for use with the Amazon Chime +// SDK, which developers use to build their own communication applications. +// For more information about the Amazon Chime SDK, see Using the Amazon Chime +// SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) in the +// Amazon Chime Developer Guide. // // You can use an AWS SDK, the AWS Command Line Interface (AWS CLI), or the // REST API to make API calls. We recommend using an AWS SDK or the AWS CLI. diff --git a/service/chimesdkmeetings/api.go b/service/chimesdkmeetings/api.go index 88b055a2e4..d6ab7c8e7d 100644 --- a/service/chimesdkmeetings/api.go +++ b/service/chimesdkmeetings/api.go @@ -56,7 +56,9 @@ func (c *ChimeSDKMeetings) BatchCreateAttendeeRequest(input *BatchCreateAttendee // BatchCreateAttendee API operation for Amazon Chime SDK Meetings. // -// Creates a group of meeting attendees. +// Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more +// information about the Amazon Chime SDK, see Using the Amazon Chime SDK (https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html) +// in the Amazon Chime Developer Guide. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2061,6 +2063,10 @@ func (s DeleteMeetingOutput) GoString() string { type EngineTranscribeMedicalSettings struct { _ struct{} `type:"structure"` + // Set this field to PHI to identify personal health information in the transcription + // output. + ContentIdentificationType *string `type:"string" enum:"TranscribeMedicalContentIdentificationType"` + // The language code specified for the Amazon Transcribe Medical engine. // // LanguageCode is a required field @@ -2121,6 +2127,12 @@ func (s *EngineTranscribeMedicalSettings) Validate() error { return nil } +// SetContentIdentificationType sets the ContentIdentificationType field's value. +func (s *EngineTranscribeMedicalSettings) SetContentIdentificationType(v string) *EngineTranscribeMedicalSettings { + s.ContentIdentificationType = &v + return s +} + // SetLanguageCode sets the LanguageCode field's value. func (s *EngineTranscribeMedicalSettings) SetLanguageCode(v string) *EngineTranscribeMedicalSettings { s.LanguageCode = &v @@ -2155,11 +2167,46 @@ func (s *EngineTranscribeMedicalSettings) SetVocabularyName(v string) *EngineTra type EngineTranscribeSettings struct { _ struct{} `type:"structure"` + // Set this field to PII to identify personal health information in the transcription + // output. + ContentIdentificationType *string `type:"string" enum:"TranscribeContentIdentificationType"` + + // Set this field to PII to redact personally identifiable information in the + // transcription output. Content redaction is performed only upon complete transcription + // of the audio segments. + // + // You can’t set both ContentRedactionType and ContentIdentificationType in + // the same request. If you set both, your request returns a BadRequestException. + ContentRedactionType *string `type:"string" enum:"TranscribeContentRedactionType"` + + // Generates partial transcription results that are less likely to change as + // meeting attendees speak. It does so by only allowing the last few words from + // the partial results to change. + EnablePartialResultsStabilization *bool `type:"boolean"` + // The language code specified for the Amazon Transcribe engine. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"TranscribeLanguageCode"` + // The name of the language model used during transcription. + LanguageModelName *string `min:"1" type:"string"` + + // The stabity level of a partial results transcription. Determines how stable + // you want the transcription results to be. A higher level means the transcription + // results are less likely to change. + PartialResultsStability *string `type:"string" enum:"TranscribePartialResultsStability"` + + // Lists the PII entity types you want to identify or redact. To specify entity + // types, you must enable ContentIdentificationType or ContentRedactionType. + // + // PIIEntityTypes must be comma-separated. The available values are: BANK_ACCOUNT_NUMBER, + // BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, + // PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, and ALL. + // + // PiiEntityTypes is an optional parameter with a default value of ALL. + PiiEntityTypes *string `min:"1" type:"string"` + // The AWS Region passed to Amazon Transcribe. If you don't specify a Region, // Amazon Chime uses the meeting's Region. Region *string `type:"string" enum:"TranscribeRegion"` @@ -2198,6 +2245,12 @@ func (s *EngineTranscribeSettings) Validate() error { if s.LanguageCode == nil { invalidParams.Add(request.NewErrParamRequired("LanguageCode")) } + if s.LanguageModelName != nil && len(*s.LanguageModelName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LanguageModelName", 1)) + } + if s.PiiEntityTypes != nil && len(*s.PiiEntityTypes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PiiEntityTypes", 1)) + } if invalidParams.Len() > 0 { return invalidParams @@ -2205,12 +2258,48 @@ func (s *EngineTranscribeSettings) Validate() error { return nil } +// SetContentIdentificationType sets the ContentIdentificationType field's value. +func (s *EngineTranscribeSettings) SetContentIdentificationType(v string) *EngineTranscribeSettings { + s.ContentIdentificationType = &v + return s +} + +// SetContentRedactionType sets the ContentRedactionType field's value. +func (s *EngineTranscribeSettings) SetContentRedactionType(v string) *EngineTranscribeSettings { + s.ContentRedactionType = &v + return s +} + +// SetEnablePartialResultsStabilization sets the EnablePartialResultsStabilization field's value. +func (s *EngineTranscribeSettings) SetEnablePartialResultsStabilization(v bool) *EngineTranscribeSettings { + s.EnablePartialResultsStabilization = &v + return s +} + // SetLanguageCode sets the LanguageCode field's value. func (s *EngineTranscribeSettings) SetLanguageCode(v string) *EngineTranscribeSettings { s.LanguageCode = &v return s } +// SetLanguageModelName sets the LanguageModelName field's value. +func (s *EngineTranscribeSettings) SetLanguageModelName(v string) *EngineTranscribeSettings { + s.LanguageModelName = &v + return s +} + +// SetPartialResultsStability sets the PartialResultsStability field's value. +func (s *EngineTranscribeSettings) SetPartialResultsStability(v string) *EngineTranscribeSettings { + s.PartialResultsStability = &v + return s +} + +// SetPiiEntityTypes sets the PiiEntityTypes field's value. +func (s *EngineTranscribeSettings) SetPiiEntityTypes(v string) *EngineTranscribeSettings { + s.PiiEntityTypes = &v + return s +} + // SetRegion sets the Region field's value. func (s *EngineTranscribeSettings) SetRegion(v string) *EngineTranscribeSettings { s.Region = &v @@ -3421,6 +3510,30 @@ func (s *UnprocessableEntityException) RequestID() string { return s.RespMetadata.RequestID } +const ( + // TranscribeContentIdentificationTypePii is a TranscribeContentIdentificationType enum value + TranscribeContentIdentificationTypePii = "PII" +) + +// TranscribeContentIdentificationType_Values returns all elements of the TranscribeContentIdentificationType enum +func TranscribeContentIdentificationType_Values() []string { + return []string{ + TranscribeContentIdentificationTypePii, + } +} + +const ( + // TranscribeContentRedactionTypePii is a TranscribeContentRedactionType enum value + TranscribeContentRedactionTypePii = "PII" +) + +// TranscribeContentRedactionType_Values returns all elements of the TranscribeContentRedactionType enum +func TranscribeContentRedactionType_Values() []string { + return []string{ + TranscribeContentRedactionTypePii, + } +} + const ( // TranscribeLanguageCodeEnUs is a TranscribeLanguageCode enum value TranscribeLanguageCodeEnUs = "en-US" @@ -3477,6 +3590,18 @@ func TranscribeLanguageCode_Values() []string { } } +const ( + // TranscribeMedicalContentIdentificationTypePhi is a TranscribeMedicalContentIdentificationType enum value + TranscribeMedicalContentIdentificationTypePhi = "PHI" +) + +// TranscribeMedicalContentIdentificationType_Values returns all elements of the TranscribeMedicalContentIdentificationType enum +func TranscribeMedicalContentIdentificationType_Values() []string { + return []string{ + TranscribeMedicalContentIdentificationTypePhi, + } +} + const ( // TranscribeMedicalLanguageCodeEnUs is a TranscribeMedicalLanguageCode enum value TranscribeMedicalLanguageCodeEnUs = "en-US" @@ -3573,6 +3698,26 @@ func TranscribeMedicalType_Values() []string { } } +const ( + // TranscribePartialResultsStabilityLow is a TranscribePartialResultsStability enum value + TranscribePartialResultsStabilityLow = "low" + + // TranscribePartialResultsStabilityMedium is a TranscribePartialResultsStability enum value + TranscribePartialResultsStabilityMedium = "medium" + + // TranscribePartialResultsStabilityHigh is a TranscribePartialResultsStability enum value + TranscribePartialResultsStabilityHigh = "high" +) + +// TranscribePartialResultsStability_Values returns all elements of the TranscribePartialResultsStability enum +func TranscribePartialResultsStability_Values() []string { + return []string{ + TranscribePartialResultsStabilityLow, + TranscribePartialResultsStabilityMedium, + TranscribePartialResultsStabilityHigh, + } +} + const ( // TranscribeRegionUsEast2 is a TranscribeRegion enum value TranscribeRegionUsEast2 = "us-east-2" diff --git a/service/chimesdkmeetings/doc.go b/service/chimesdkmeetings/doc.go index 2e0fbdd57c..162920391f 100644 --- a/service/chimesdkmeetings/doc.go +++ b/service/chimesdkmeetings/doc.go @@ -5,8 +5,7 @@ // // The Amazon Chime SDK meetings APIs in this section allow software developers // to create Amazon Chime SDK meetings, set the AWS Regions for meetings, create -// and manage users, and send and receive meeting notifications. For more information -// about the meeting APIs, see Amazon Chime SDK meetings (http://amazonaws.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_meetings). +// and manage users, and send and receive meeting notifications. // // See https://docs.aws.amazon.com/goto/WebAPI/chime-sdk-meetings-2021-07-15 for more information on this service. // diff --git a/service/cloudwatch/api.go b/service/cloudwatch/api.go index 5da42c0feb..33353b75a2 100644 --- a/service/cloudwatch/api.go +++ b/service/cloudwatch/api.go @@ -179,6 +179,9 @@ func (c *CloudWatch) DeleteAnomalyDetectorRequest(input *DeleteAnomalyDetectorIn // * ErrCodeMissingRequiredParameterException "MissingParameter" // An input parameter that is required is missing. // +// * ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" +// Parameters were used together that cannot be used together. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DeleteAnomalyDetector func (c *CloudWatch) DeleteAnomalyDetector(input *DeleteAnomalyDetectorInput) (*DeleteAnomalyDetectorOutput, error) { req, out := c.DeleteAnomalyDetectorRequest(input) @@ -515,6 +518,11 @@ func (c *CloudWatch) DescribeAlarmHistoryRequest(input *DescribeAlarmHistoryInpu // // CloudWatch retains the history of an alarm even if you delete the alarm. // +// To use this operation and return information about a composite alarm, you +// must be signed on with the cloudwatch:DescribeAlarmHistory permission that +// is scoped to *. You can't return information about composite alarms if your +// cloudwatch:DescribeAlarmHistory permission has a narrower scope. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -653,6 +661,11 @@ func (c *CloudWatch) DescribeAlarmsRequest(input *DescribeAlarmsInput) (req *req // Retrieves the specified alarms. You can filter the results by specifying // a prefix for the alarm name, the alarm state, or a prefix for any action. // +// To use this operation and return information about composite alarms, you +// must be signed on with the cloudwatch:DescribeAlarms permission that is scoped +// to *. You can't return information about composite alarms if your cloudwatch:DescribeAlarms +// permission has a narrower scope. +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -862,8 +875,11 @@ func (c *CloudWatch) DescribeAnomalyDetectorsRequest(input *DescribeAnomalyDetec // DescribeAnomalyDetectors API operation for Amazon CloudWatch. // // Lists the anomaly detection models that you have created in your account. -// You can list all models in your account or filter the results to only the -// models that are related to a certain namespace, metric name, or metric dimension. +// For single metric anomaly detectors, you can list all of the models in your +// account or filter the results to only the models that are related to a certain +// namespace, metric name, or metric dimension. For metric math anomaly detectors, +// you can list them by adding METRIC_MATH to the AnomalyDetectorTypes array. +// This will return all metric math anomaly detectors in your account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -882,6 +898,9 @@ func (c *CloudWatch) DescribeAnomalyDetectorsRequest(input *DescribeAnomalyDetec // * ErrCodeInvalidParameterValueException "InvalidParameterValue" // The value of an input parameter is bad or out-of-range. // +// * ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" +// Parameters were used together that cannot be used together. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/DescribeAnomalyDetectors func (c *CloudWatch) DescribeAnomalyDetectors(input *DescribeAnomalyDetectorsInput) (*DescribeAnomalyDetectorsOutput, error) { req, out := c.DescribeAnomalyDetectorsRequest(input) @@ -2669,6 +2688,9 @@ func (c *CloudWatch) PutAnomalyDetectorRequest(input *PutAnomalyDetectorInput) ( // * ErrCodeMissingRequiredParameterException "MissingParameter" // An input parameter that is required is missing. // +// * ErrCodeInvalidParameterCombinationException "InvalidParameterCombination" +// Parameters were used together that cannot be used together. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/monitoring-2010-08-01/PutAnomalyDetector func (c *CloudWatch) PutAnomalyDetector(input *PutAnomalyDetectorInput) (*PutAnomalyDetectorOutput, error) { req, out := c.PutAnomalyDetectorRequest(input) @@ -2776,6 +2798,10 @@ func (c *CloudWatch) PutCompositeAlarmRequest(input *PutCompositeAlarmInput) (re // When you update an existing alarm, its state is left unchanged, but the update // completely overwrites the previous configuration of the alarm. // +// To use this operation, you must be signed on with the cloudwatch:PutCompositeAlarm +// permission that is scoped to *. You can't create a composite alarms if your +// cloudwatch:PutCompositeAlarm permission has a narrower scope. +// // If you are an IAM user, you must have iam:CreateServiceLinkedRole to create // a composite alarm that has Systems Manager OpsItem actions. // @@ -3068,11 +3094,11 @@ func (c *CloudWatch) PutMetricAlarmRequest(input *PutMetricAlarmInput) (req *req // * The iam:CreateServiceLinkedRole to create an alarm with Systems Manager // OpsItem actions. // -// The first time you create an alarm in the Management Console, the CLI, or -// by using the PutMetricAlarm API, CloudWatch creates the necessary service-linked -// role for you. The service-linked roles are called AWSServiceRoleForCloudWatchEvents -// and AWSServiceRoleForCloudWatchAlarms_ActionSSM. For more information, see -// Amazon Web Services service-linked role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role). +// The first time you create an alarm in the Amazon Web Services Management +// Console, the CLI, or by using the PutMetricAlarm API, CloudWatch creates +// the necessary service-linked role for you. The service-linked roles are called +// AWSServiceRoleForCloudWatchEvents and AWSServiceRoleForCloudWatchAlarms_ActionSSM. +// For more information, see Amazon Web Services service-linked role (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html#iam-term-service-linked-role). // // Cross-account alarms // @@ -3311,7 +3337,7 @@ func (c *CloudWatch) PutMetricStreamRequest(input *PutMetricStreamInput) (req *r // CloudWatch metrics to Amazon Web Services destinations including Amazon S3 // and to many third-party solutions. // -// For more information, see Using Metric Streams (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Metric-Streams.html). +// For more information, see Using Metric Streams (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Metric-Streams.html). // // To create a metric stream, you must be logged on to an account that has the // iam:PassRole permission and either the CloudWatchFullAccess policy or the @@ -3920,9 +3946,9 @@ func (s *AlarmHistoryItem) SetTimestamp(v time.Time) *AlarmHistoryItem { return s } -// An anomaly detection model associated with a particular CloudWatch metric -// and statistic. You can use the model to display a band of expected normal -// values when the metric is graphed. +// An anomaly detection model associated with a particular CloudWatch metric, +// statistic, or metric math expression. You can use the model to display a +// band of expected, normal values when the metric is graphed. type AnomalyDetector struct { _ struct{} `type:"structure"` @@ -3932,16 +3958,30 @@ type AnomalyDetector struct { Configuration *AnomalyDetectorConfiguration `type:"structure"` // The metric dimensions associated with the anomaly detection model. - Dimensions []*Dimension `type:"list"` + // + // Deprecated: Use SingleMetricAnomalyDetector.Dimensions property. + Dimensions []*Dimension `deprecated:"true" type:"list"` + + // The CloudWatch metric math expression for this anomaly detector. + MetricMathAnomalyDetector *MetricMathAnomalyDetector `type:"structure"` // The name of the metric associated with the anomaly detection model. - MetricName *string `min:"1" type:"string"` + // + // Deprecated: Use SingleMetricAnomalyDetector.MetricName property. + MetricName *string `min:"1" deprecated:"true" type:"string"` // The namespace of the metric associated with the anomaly detection model. - Namespace *string `min:"1" type:"string"` + // + // Deprecated: Use SingleMetricAnomalyDetector.Namespace property. + Namespace *string `min:"1" deprecated:"true" type:"string"` + + // The CloudWatch metric and statistic for this anomaly detector. + SingleMetricAnomalyDetector *SingleMetricAnomalyDetector `type:"structure"` // The statistic associated with the anomaly detection model. - Stat *string `type:"string"` + // + // Deprecated: Use SingleMetricAnomalyDetector.Stat property. + Stat *string `deprecated:"true" type:"string"` // The current status of the anomaly detector's training. The possible values // are TRAINED | PENDING_TRAINING | TRAINED_INSUFFICIENT_DATA @@ -3978,6 +4018,12 @@ func (s *AnomalyDetector) SetDimensions(v []*Dimension) *AnomalyDetector { return s } +// SetMetricMathAnomalyDetector sets the MetricMathAnomalyDetector field's value. +func (s *AnomalyDetector) SetMetricMathAnomalyDetector(v *MetricMathAnomalyDetector) *AnomalyDetector { + s.MetricMathAnomalyDetector = v + return s +} + // SetMetricName sets the MetricName field's value. func (s *AnomalyDetector) SetMetricName(v string) *AnomalyDetector { s.MetricName = &v @@ -3990,6 +4036,12 @@ func (s *AnomalyDetector) SetNamespace(v string) *AnomalyDetector { return s } +// SetSingleMetricAnomalyDetector sets the SingleMetricAnomalyDetector field's value. +func (s *AnomalyDetector) SetSingleMetricAnomalyDetector(v *SingleMetricAnomalyDetector) *AnomalyDetector { + s.SingleMetricAnomalyDetector = v + return s +} + // SetStat sets the Stat field's value. func (s *AnomalyDetector) SetStat(v string) *AnomalyDetector { s.Stat = &v @@ -4488,22 +4540,62 @@ type DeleteAnomalyDetectorInput struct { _ struct{} `type:"structure"` // The metric dimensions associated with the anomaly detection model to delete. - Dimensions []*Dimension `type:"list"` + // + // Deprecated: Use SingleMetricAnomalyDetector. + Dimensions []*Dimension `deprecated:"true" type:"list"` + + // The metric math anomaly detector to be deleted. + // + // When using MetricMathAnomalyDetector, you cannot include following parameters + // in the same operation: + // + // * Dimensions, + // + // * MetricName + // + // * Namespace + // + // * Stat + // + // * the SingleMetricAnomalyDetector parameters of DeleteAnomalyDetectorInput + // + // Instead, specify the metric math anomaly detector attributes as part of the + // MetricMathAnomalyDetector property. + MetricMathAnomalyDetector *MetricMathAnomalyDetector `type:"structure"` // The metric name associated with the anomaly detection model to delete. // - // MetricName is a required field - MetricName *string `min:"1" type:"string" required:"true"` + // Deprecated: Use SingleMetricAnomalyDetector. + MetricName *string `min:"1" deprecated:"true" type:"string"` // The namespace associated with the anomaly detection model to delete. // - // Namespace is a required field - Namespace *string `min:"1" type:"string" required:"true"` + // Deprecated: Use SingleMetricAnomalyDetector. + Namespace *string `min:"1" deprecated:"true" type:"string"` + + // A single metric anomaly detector to be deleted. + // + // When using SingleMetricAnomalyDetector, you cannot include the following + // parameters in the same operation: + // + // * Dimensions, + // + // * MetricName + // + // * Namespace + // + // * Stat + // + // * the MetricMathAnomalyDetector parameters of DeleteAnomalyDetectorInput + // + // Instead, specify the single metric anomaly detector attributes as part of + // the SingleMetricAnomalyDetector property. + SingleMetricAnomalyDetector *SingleMetricAnomalyDetector `type:"structure"` // The statistic associated with the anomaly detection model to delete. // - // Stat is a required field - Stat *string `type:"string" required:"true"` + // Deprecated: Use SingleMetricAnomalyDetector. + Stat *string `deprecated:"true" type:"string"` } // String returns the string representation. @@ -4527,21 +4619,12 @@ func (s DeleteAnomalyDetectorInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *DeleteAnomalyDetectorInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "DeleteAnomalyDetectorInput"} - if s.MetricName == nil { - invalidParams.Add(request.NewErrParamRequired("MetricName")) - } if s.MetricName != nil && len(*s.MetricName) < 1 { invalidParams.Add(request.NewErrParamMinLen("MetricName", 1)) } - if s.Namespace == nil { - invalidParams.Add(request.NewErrParamRequired("Namespace")) - } if s.Namespace != nil && len(*s.Namespace) < 1 { invalidParams.Add(request.NewErrParamMinLen("Namespace", 1)) } - if s.Stat == nil { - invalidParams.Add(request.NewErrParamRequired("Stat")) - } if s.Dimensions != nil { for i, v := range s.Dimensions { if v == nil { @@ -4552,6 +4635,16 @@ func (s *DeleteAnomalyDetectorInput) Validate() error { } } } + if s.MetricMathAnomalyDetector != nil { + if err := s.MetricMathAnomalyDetector.Validate(); err != nil { + invalidParams.AddNested("MetricMathAnomalyDetector", err.(request.ErrInvalidParams)) + } + } + if s.SingleMetricAnomalyDetector != nil { + if err := s.SingleMetricAnomalyDetector.Validate(); err != nil { + invalidParams.AddNested("SingleMetricAnomalyDetector", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -4565,6 +4658,12 @@ func (s *DeleteAnomalyDetectorInput) SetDimensions(v []*Dimension) *DeleteAnomal return s } +// SetMetricMathAnomalyDetector sets the MetricMathAnomalyDetector field's value. +func (s *DeleteAnomalyDetectorInput) SetMetricMathAnomalyDetector(v *MetricMathAnomalyDetector) *DeleteAnomalyDetectorInput { + s.MetricMathAnomalyDetector = v + return s +} + // SetMetricName sets the MetricName field's value. func (s *DeleteAnomalyDetectorInput) SetMetricName(v string) *DeleteAnomalyDetectorInput { s.MetricName = &v @@ -4577,6 +4676,12 @@ func (s *DeleteAnomalyDetectorInput) SetNamespace(v string) *DeleteAnomalyDetect return s } +// SetSingleMetricAnomalyDetector sets the SingleMetricAnomalyDetector field's value. +func (s *DeleteAnomalyDetectorInput) SetSingleMetricAnomalyDetector(v *SingleMetricAnomalyDetector) *DeleteAnomalyDetectorInput { + s.SingleMetricAnomalyDetector = v + return s +} + // SetStat sets the Stat field's value. func (s *DeleteAnomalyDetectorInput) SetStat(v string) *DeleteAnomalyDetectorInput { s.Stat = &v @@ -5352,6 +5457,10 @@ func (s *DescribeAlarmsOutput) SetNextToken(v string) *DescribeAlarmsOutput { type DescribeAnomalyDetectorsInput struct { _ struct{} `type:"structure"` + // The anomaly detector types to request when using DescribeAnomalyDetectorsInput. + // If empty, defaults to SINGLE_METRIC. + AnomalyDetectorTypes []*string `type:"list"` + // Limits the results to only the anomaly detection models that are associated // with the specified metric dimensions. If there are multiple metrics that // have these dimensions and have anomaly detection models associated, they're @@ -5426,6 +5535,12 @@ func (s *DescribeAnomalyDetectorsInput) Validate() error { return nil } +// SetAnomalyDetectorTypes sets the AnomalyDetectorTypes field's value. +func (s *DescribeAnomalyDetectorsInput) SetAnomalyDetectorTypes(v []*string) *DescribeAnomalyDetectorsInput { + s.AnomalyDetectorTypes = v + return s +} + // SetDimensions sets the Dimensions field's value. func (s *DescribeAnomalyDetectorsInput) SetDimensions(v []*Dimension) *DescribeAnomalyDetectorsInput { s.Dimensions = v @@ -7137,7 +7252,10 @@ func (s *GetMetricWidgetImageOutput) SetMetricWidgetImage(v []byte) *GetMetricWi return s } -// This structure contains the definition for a Contributor Insights rule. +// This structure contains the definition for a Contributor Insights rule. For +// more information about this rule, see Using Constributor Insights to analyze +// high-cardinality data (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/ContributorInsights.html) +// in the Amazon CloudWatch User Guide. type InsightRule struct { _ struct{} `type:"structure"` @@ -7155,7 +7273,7 @@ type InsightRule struct { Name *string `min:"1" type:"string" required:"true"` // For rules that you create, this is always {"Name": "CloudWatchLogRule", "Version": - // 1}. For built-in rules, this is {"Name": "ServiceLogRule", "Version": 1} + // 1}. For managed rules, this is {"Name": "ServiceLogRule", "Version": 1} // // Schema is a required field Schema *string `type:"string" required:"true"` @@ -8748,6 +8866,66 @@ func (s *MetricDatum) SetValues(v []*float64) *MetricDatum { return s } +// Indicates the CloudWatch math expression that provides the time series the +// anomaly detector uses as input. The designated math expression must return +// a single time series. +type MetricMathAnomalyDetector struct { + _ struct{} `type:"structure"` + + // An array of metric data query structures that enables you to create an anomaly + // detector based on the result of a metric math expression. Each item in MetricDataQueries + // gets a metric or performs a math expression. One item in MetricDataQueries + // is the expression that provides the time series that the anomaly detector + // uses as input. Designate the expression by setting ReturnData to True for + // this object in the array. For all other expressions and metrics, set ReturnData + // to False. The designated expression must return a single time series. + MetricDataQueries []*MetricDataQuery `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MetricMathAnomalyDetector) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s MetricMathAnomalyDetector) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *MetricMathAnomalyDetector) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "MetricMathAnomalyDetector"} + if s.MetricDataQueries != nil { + for i, v := range s.MetricDataQueries { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "MetricDataQueries", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMetricDataQueries sets the MetricDataQueries field's value. +func (s *MetricMathAnomalyDetector) SetMetricDataQueries(v []*MetricDataQuery) *MetricMathAnomalyDetector { + s.MetricDataQueries = v + return s +} + // This structure defines the metric to be returned, along with the statistics, // period, and units. type MetricStat struct { @@ -9073,22 +9251,62 @@ type PutAnomalyDetectorInput struct { Configuration *AnomalyDetectorConfiguration `type:"structure"` // The metric dimensions to create the anomaly detection model for. - Dimensions []*Dimension `type:"list"` + // + // Deprecated: Use SingleMetricAnomalyDetector. + Dimensions []*Dimension `deprecated:"true" type:"list"` + + // The metric math anomaly detector to be created. + // + // When using MetricMathAnomalyDetector, you cannot include the following parameters + // in the same operation: + // + // * Dimensions + // + // * MetricName + // + // * Namespace + // + // * Stat + // + // * the SingleMetricAnomalyDetector parameters of PutAnomalyDetectorInput + // + // Instead, specify the metric math anomaly detector attributes as part of the + // property MetricMathAnomalyDetector. + MetricMathAnomalyDetector *MetricMathAnomalyDetector `type:"structure"` // The name of the metric to create the anomaly detection model for. // - // MetricName is a required field - MetricName *string `min:"1" type:"string" required:"true"` + // Deprecated: Use SingleMetricAnomalyDetector. + MetricName *string `min:"1" deprecated:"true" type:"string"` // The namespace of the metric to create the anomaly detection model for. // - // Namespace is a required field - Namespace *string `min:"1" type:"string" required:"true"` + // Deprecated: Use SingleMetricAnomalyDetector. + Namespace *string `min:"1" deprecated:"true" type:"string"` + + // A single metric anomaly detector to be created. + // + // When using SingleMetricAnomalyDetector, you cannot include the following + // parameters in the same operation: + // + // * Dimensions + // + // * MetricName + // + // * Namespace + // + // * Stat + // + // * the MetricMatchAnomalyDetector parameters of PutAnomalyDetectorInput + // + // Instead, specify the single metric anomaly detector attributes as part of + // the property SingleMetricAnomalyDetector. + SingleMetricAnomalyDetector *SingleMetricAnomalyDetector `type:"structure"` // The statistic to use for the metric and the anomaly detection model. // - // Stat is a required field - Stat *string `type:"string" required:"true"` + // Deprecated: Use SingleMetricAnomalyDetector. + Stat *string `deprecated:"true" type:"string"` } // String returns the string representation. @@ -9112,21 +9330,12 @@ func (s PutAnomalyDetectorInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *PutAnomalyDetectorInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "PutAnomalyDetectorInput"} - if s.MetricName == nil { - invalidParams.Add(request.NewErrParamRequired("MetricName")) - } if s.MetricName != nil && len(*s.MetricName) < 1 { invalidParams.Add(request.NewErrParamMinLen("MetricName", 1)) } - if s.Namespace == nil { - invalidParams.Add(request.NewErrParamRequired("Namespace")) - } if s.Namespace != nil && len(*s.Namespace) < 1 { invalidParams.Add(request.NewErrParamMinLen("Namespace", 1)) } - if s.Stat == nil { - invalidParams.Add(request.NewErrParamRequired("Stat")) - } if s.Configuration != nil { if err := s.Configuration.Validate(); err != nil { invalidParams.AddNested("Configuration", err.(request.ErrInvalidParams)) @@ -9142,6 +9351,16 @@ func (s *PutAnomalyDetectorInput) Validate() error { } } } + if s.MetricMathAnomalyDetector != nil { + if err := s.MetricMathAnomalyDetector.Validate(); err != nil { + invalidParams.AddNested("MetricMathAnomalyDetector", err.(request.ErrInvalidParams)) + } + } + if s.SingleMetricAnomalyDetector != nil { + if err := s.SingleMetricAnomalyDetector.Validate(); err != nil { + invalidParams.AddNested("SingleMetricAnomalyDetector", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -9161,6 +9380,12 @@ func (s *PutAnomalyDetectorInput) SetDimensions(v []*Dimension) *PutAnomalyDetec return s } +// SetMetricMathAnomalyDetector sets the MetricMathAnomalyDetector field's value. +func (s *PutAnomalyDetectorInput) SetMetricMathAnomalyDetector(v *MetricMathAnomalyDetector) *PutAnomalyDetectorInput { + s.MetricMathAnomalyDetector = v + return s +} + // SetMetricName sets the MetricName field's value. func (s *PutAnomalyDetectorInput) SetMetricName(v string) *PutAnomalyDetectorInput { s.MetricName = &v @@ -9173,6 +9398,12 @@ func (s *PutAnomalyDetectorInput) SetNamespace(v string) *PutAnomalyDetectorInpu return s } +// SetSingleMetricAnomalyDetector sets the SingleMetricAnomalyDetector field's value. +func (s *PutAnomalyDetectorInput) SetSingleMetricAnomalyDetector(v *SingleMetricAnomalyDetector) *PutAnomalyDetectorInput { + s.SingleMetricAnomalyDetector = v + return s +} + // SetStat sets the Stat field's value. func (s *PutAnomalyDetectorInput) SetStat(v string) *PutAnomalyDetectorInput { s.Stat = &v @@ -10616,6 +10847,92 @@ func (s SetAlarmStateOutput) GoString() string { return s.String() } +// Designates the CloudWatch metric and statistic that provides the time series +// the anomaly detector uses as input. +type SingleMetricAnomalyDetector struct { + _ struct{} `type:"structure"` + + // The metric dimensions to create the anomaly detection model for. + Dimensions []*Dimension `type:"list"` + + // The name of the metric to create the anomaly detection model for. + MetricName *string `min:"1" type:"string"` + + // The namespace of the metric to create the anomaly detection model for. + Namespace *string `min:"1" type:"string"` + + // The statistic to use for the metric and anomaly detection model. + Stat *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SingleMetricAnomalyDetector) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SingleMetricAnomalyDetector) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SingleMetricAnomalyDetector) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SingleMetricAnomalyDetector"} + if s.MetricName != nil && len(*s.MetricName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("MetricName", 1)) + } + if s.Namespace != nil && len(*s.Namespace) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Namespace", 1)) + } + if s.Dimensions != nil { + for i, v := range s.Dimensions { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Dimensions", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDimensions sets the Dimensions field's value. +func (s *SingleMetricAnomalyDetector) SetDimensions(v []*Dimension) *SingleMetricAnomalyDetector { + s.Dimensions = v + return s +} + +// SetMetricName sets the MetricName field's value. +func (s *SingleMetricAnomalyDetector) SetMetricName(v string) *SingleMetricAnomalyDetector { + s.MetricName = &v + return s +} + +// SetNamespace sets the Namespace field's value. +func (s *SingleMetricAnomalyDetector) SetNamespace(v string) *SingleMetricAnomalyDetector { + s.Namespace = &v + return s +} + +// SetStat sets the Stat field's value. +func (s *SingleMetricAnomalyDetector) SetStat(v string) *SingleMetricAnomalyDetector { + s.Stat = &v + return s +} + type StartMetricStreamsInput struct { _ struct{} `type:"structure"` @@ -11146,6 +11463,22 @@ func AnomalyDetectorStateValue_Values() []string { } } +const ( + // AnomalyDetectorTypeSingleMetric is a AnomalyDetectorType enum value + AnomalyDetectorTypeSingleMetric = "SINGLE_METRIC" + + // AnomalyDetectorTypeMetricMath is a AnomalyDetectorType enum value + AnomalyDetectorTypeMetricMath = "METRIC_MATH" +) + +// AnomalyDetectorType_Values returns all elements of the AnomalyDetectorType enum +func AnomalyDetectorType_Values() []string { + return []string{ + AnomalyDetectorTypeSingleMetric, + AnomalyDetectorTypeMetricMath, + } +} + const ( // ComparisonOperatorGreaterThanOrEqualToThreshold is a ComparisonOperator enum value ComparisonOperatorGreaterThanOrEqualToThreshold = "GreaterThanOrEqualToThreshold" diff --git a/service/forecastservice/api.go b/service/forecastservice/api.go index 77339e511c..ae842fe021 100644 --- a/service/forecastservice/api.go +++ b/service/forecastservice/api.go @@ -13,6 +13,130 @@ import ( "github.com/aws/aws-sdk-go/private/protocol/jsonrpc" ) +const opCreateAutoPredictor = "CreateAutoPredictor" + +// CreateAutoPredictorRequest generates a "aws/request.Request" representing the +// client's request for the CreateAutoPredictor operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateAutoPredictor for more information on using the CreateAutoPredictor +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateAutoPredictorRequest method. +// req, resp := client.CreateAutoPredictorRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictor +func (c *ForecastService) CreateAutoPredictorRequest(input *CreateAutoPredictorInput) (req *request.Request, output *CreateAutoPredictorOutput) { + op := &request.Operation{ + Name: opCreateAutoPredictor, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateAutoPredictorInput{} + } + + output = &CreateAutoPredictorOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateAutoPredictor API operation for Amazon Forecast Service. +// +// Creates an Amazon Forecast predictor. +// +// Amazon Forecast creates predictors with AutoPredictor, which involves applying +// the optimal combination of algorithms to each time series in your datasets. +// You can use CreateAutoPredictor to create new predictors or upgrade/retrain +// existing predictors. +// +// Creating new predictors +// +// The following parameters are required when creating a new predictor: +// +// * PredictorName - A unique name for the predictor. +// +// * DatasetGroupArn - The ARN of the dataset group used to train the predictor. +// +// * ForecastFrequency - The granularity of your forecasts (hourly, daily, +// weekly, etc). +// +// * ForecastHorizon - The number of time steps being forecasted. +// +// When creating a new predictor, do not specify a value for ReferencePredictorArn. +// +// Upgrading and retraining predictors +// +// The following parameters are required when retraining or upgrading a predictor: +// +// * PredictorName - A unique name for the predictor. +// +// * ReferencePredictorArn - The ARN of the predictor to retrain or upgrade. +// +// When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn +// and PredictorName. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Forecast Service's +// API operation CreateAutoPredictor for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// We can't process the request because it includes an invalid value or a value +// that exceeds the valid range. +// +// * ResourceAlreadyExistsException +// There is already a resource with this name. Try again with a different name. +// +// * ResourceNotFoundException +// We can't find a resource with that Amazon Resource Name (ARN). Check the +// ARN and try again. +// +// * ResourceInUseException +// The specified resource is in use. +// +// * LimitExceededException +// The limit on the number of resources per account has been exceeded. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateAutoPredictor +func (c *ForecastService) CreateAutoPredictor(input *CreateAutoPredictorInput) (*CreateAutoPredictorOutput, error) { + req, out := c.CreateAutoPredictorRequest(input) + return out, req.Send() +} + +// CreateAutoPredictorWithContext is the same as CreateAutoPredictor with the addition of +// the ability to pass a context and additional request options. +// +// See CreateAutoPredictor for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ForecastService) CreateAutoPredictorWithContext(ctx aws.Context, input *CreateAutoPredictorInput, opts ...request.Option) (*CreateAutoPredictorOutput, error) { + req, out := c.CreateAutoPredictorRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateDataset = "CreateDataset" // CreateDatasetRequest generates a "aws/request.Request" representing the @@ -344,76 +468,131 @@ func (c *ForecastService) CreateDatasetImportJobWithContext(ctx aws.Context, inp return out, req.Send() } -const opCreateForecast = "CreateForecast" +const opCreateExplainability = "CreateExplainability" -// CreateForecastRequest generates a "aws/request.Request" representing the -// client's request for the CreateForecast operation. The "output" return +// CreateExplainabilityRequest generates a "aws/request.Request" representing the +// client's request for the CreateExplainability operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See CreateForecast for more information on using the CreateForecast +// See CreateExplainability for more information on using the CreateExplainability // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the CreateForecastRequest method. -// req, resp := client.CreateForecastRequest(params) +// // Example sending a request using the CreateExplainabilityRequest method. +// req, resp := client.CreateExplainabilityRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecast -func (c *ForecastService) CreateForecastRequest(input *CreateForecastInput) (req *request.Request, output *CreateForecastOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainability +func (c *ForecastService) CreateExplainabilityRequest(input *CreateExplainabilityInput) (req *request.Request, output *CreateExplainabilityOutput) { op := &request.Operation{ - Name: opCreateForecast, + Name: opCreateExplainability, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &CreateForecastInput{} + input = &CreateExplainabilityInput{} } - output = &CreateForecastOutput{} + output = &CreateExplainabilityOutput{} req = c.newRequest(op, input, output) return } -// CreateForecast API operation for Amazon Forecast Service. +// CreateExplainability API operation for Amazon Forecast Service. // -// Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was -// used to train the predictor. This is known as inference. To retrieve the -// forecast for a single item at low latency, use the operation. To export the -// complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, -// use the CreateForecastExportJob operation. // -// The range of the forecast is determined by the ForecastHorizon value, which -// you specify in the CreatePredictor request. When you query a forecast, you -// can request a specific date range within the forecast. +// Explainability is only available for Forecasts and Predictors generated from +// an AutoPredictor (CreateAutoPredictor) // -// To get a list of all your forecasts, use the ListForecasts operation. +// Creates an Amazon Forecast Explainability. // -// The forecasts generated by Amazon Forecast are in the same time zone as the -// dataset that was used to create the predictor. +// Explainability helps you better understand how the attributes in your datasets +// impact forecast. Amazon Forecast uses a metric called Impact scores to quantify +// the relative impact of each attribute and determine whether they increase +// or decrease forecast values. // -// For more information, see howitworks-forecast. +// To enable Forecast Explainability, your predictor must include at least one +// of the following: related time series, item metadata, or additional datasets +// like Holidays and the Weather Index. // -// The Status of the forecast must be ACTIVE before you can query or export -// the forecast. Use the DescribeForecast operation to get the status. +// CreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive +// aggregated Impact scores for all time series and time points in your datasets, +// provide a Predictor ARN. To receive Impact scores for specific time series +// and time points, provide a Forecast ARN. +// +// CreateExplainability with a Predictor ARN +// +// You can only have one Explainability resource per predictor. If you already +// enabled ExplainPredictor in CreateAutoPredictor, that predictor already has +// an Explainability resource. +// +// The following parameters are required when providing a Predictor ARN: +// +// * ExplainabilityName - A unique name for the Explainability. +// +// * ResourceArn - The Arn of the predictor. +// +// * TimePointGranularity - Must be set to “ALL”. +// +// * TimeSeriesGranularity - Must be set to “ALL”. +// +// Do not specify a value for the following parameters: +// +// * DataSource - Only valid when TimeSeriesGranularity is “SPECIFIC”. +// +// * Schema - Only valid when TimeSeriesGranularity is “SPECIFIC”. +// +// * StartDateTime - Only valid when TimePointGranularity is “SPECIFIC”. +// +// * EndDateTime - Only valid when TimePointGranularity is “SPECIFIC”. +// +// CreateExplainability with a Forecast ARN +// +// You can specify a maximum of 50 time series and 1500 time points. +// +// The following parameters are required when providing a Predictor ARN: +// +// * ExplainabilityName - A unique name for the Explainability. +// +// * ResourceArn - The Arn of the forecast. +// +// * TimePointGranularity - Either “ALL” or “SPECIFIC”. +// +// * TimeSeriesGranularity - Either “ALL” or “SPECIFIC”. +// +// If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide +// the following: +// +// * DataSource - The S3 location of the CSV file specifying your time series. +// +// * Schema - The Schema defines the attributes and attribute types listed +// in the Data Source. +// +// If you set TimePointGranularity to “SPECIFIC”, you must also provide +// the following: +// +// * StartDateTime - The first timestamp in the range of time points. +// +// * EndDateTime - The last timestamp in the range of time points. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Forecast Service's -// API operation CreateForecast for usage and error information. +// API operation CreateExplainability for usage and error information. // // Returned Error Types: // * InvalidInputException @@ -433,91 +612,82 @@ func (c *ForecastService) CreateForecastRequest(input *CreateForecastInput) (req // * LimitExceededException // The limit on the number of resources per account has been exceeded. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecast -func (c *ForecastService) CreateForecast(input *CreateForecastInput) (*CreateForecastOutput, error) { - req, out := c.CreateForecastRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainability +func (c *ForecastService) CreateExplainability(input *CreateExplainabilityInput) (*CreateExplainabilityOutput, error) { + req, out := c.CreateExplainabilityRequest(input) return out, req.Send() } -// CreateForecastWithContext is the same as CreateForecast with the addition of +// CreateExplainabilityWithContext is the same as CreateExplainability with the addition of // the ability to pass a context and additional request options. // -// See CreateForecast for details on how to use this API operation. +// See CreateExplainability for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *ForecastService) CreateForecastWithContext(ctx aws.Context, input *CreateForecastInput, opts ...request.Option) (*CreateForecastOutput, error) { - req, out := c.CreateForecastRequest(input) +func (c *ForecastService) CreateExplainabilityWithContext(ctx aws.Context, input *CreateExplainabilityInput, opts ...request.Option) (*CreateExplainabilityOutput, error) { + req, out := c.CreateExplainabilityRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opCreateForecastExportJob = "CreateForecastExportJob" +const opCreateExplainabilityExport = "CreateExplainabilityExport" -// CreateForecastExportJobRequest generates a "aws/request.Request" representing the -// client's request for the CreateForecastExportJob operation. The "output" return +// CreateExplainabilityExportRequest generates a "aws/request.Request" representing the +// client's request for the CreateExplainabilityExport operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See CreateForecastExportJob for more information on using the CreateForecastExportJob +// See CreateExplainabilityExport for more information on using the CreateExplainabilityExport // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the CreateForecastExportJobRequest method. -// req, resp := client.CreateForecastExportJobRequest(params) +// // Example sending a request using the CreateExplainabilityExportRequest method. +// req, resp := client.CreateExplainabilityExportRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastExportJob -func (c *ForecastService) CreateForecastExportJobRequest(input *CreateForecastExportJobInput) (req *request.Request, output *CreateForecastExportJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityExport +func (c *ForecastService) CreateExplainabilityExportRequest(input *CreateExplainabilityExportInput) (req *request.Request, output *CreateExplainabilityExportOutput) { op := &request.Operation{ - Name: opCreateForecastExportJob, + Name: opCreateExplainabilityExport, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &CreateForecastExportJobInput{} + input = &CreateExplainabilityExportInput{} } - output = &CreateForecastExportJobOutput{} + output = &CreateExplainabilityExportOutput{} req = c.newRequest(op, input, output) return } -// CreateForecastExportJob API operation for Amazon Forecast Service. -// -// Exports a forecast created by the CreateForecast operation to your Amazon -// Simple Storage Service (Amazon S3) bucket. The forecast file name will match -// the following conventions: -// -// __ -// -// where the component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ). -// -// You must specify a DataDestination object that includes an AWS Identity and -// Access Management (IAM) role that Amazon Forecast can assume to access the -// Amazon S3 bucket. For more information, see aws-forecast-iam-roles. +// CreateExplainabilityExport API operation for Amazon Forecast Service. // -// For more information, see howitworks-forecast. +// Exports an Explainability resource created by the CreateExplainability operation. +// Exported files are exported to an Amazon Simple Storage Service (Amazon S3) +// bucket. // -// To get a list of all your forecast export jobs, use the ListForecastExportJobs -// operation. +// You must specify a DataDestination object that includes an Amazon S3 bucket +// and an AWS Identity and Access Management (IAM) role that Amazon Forecast +// can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles. // -// The Status of the forecast export job must be ACTIVE before you can access -// the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob +// The Status of the export job must be ACTIVE before you can access the export +// in your Amazon S3 bucket. To get the status, use the DescribeExplainabilityExport // operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions @@ -525,7 +695,7 @@ func (c *ForecastService) CreateForecastExportJobRequest(input *CreateForecastEx // the error. // // See the AWS API reference guide for Amazon Forecast Service's -// API operation CreateForecastExportJob for usage and error information. +// API operation CreateExplainabilityExport for usage and error information. // // Returned Error Types: // * InvalidInputException @@ -545,106 +715,334 @@ func (c *ForecastService) CreateForecastExportJobRequest(input *CreateForecastEx // * LimitExceededException // The limit on the number of resources per account has been exceeded. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastExportJob -func (c *ForecastService) CreateForecastExportJob(input *CreateForecastExportJobInput) (*CreateForecastExportJobOutput, error) { - req, out := c.CreateForecastExportJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateExplainabilityExport +func (c *ForecastService) CreateExplainabilityExport(input *CreateExplainabilityExportInput) (*CreateExplainabilityExportOutput, error) { + req, out := c.CreateExplainabilityExportRequest(input) return out, req.Send() } -// CreateForecastExportJobWithContext is the same as CreateForecastExportJob with the addition of +// CreateExplainabilityExportWithContext is the same as CreateExplainabilityExport with the addition of // the ability to pass a context and additional request options. // -// See CreateForecastExportJob for details on how to use this API operation. +// See CreateExplainabilityExport for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *ForecastService) CreateForecastExportJobWithContext(ctx aws.Context, input *CreateForecastExportJobInput, opts ...request.Option) (*CreateForecastExportJobOutput, error) { - req, out := c.CreateForecastExportJobRequest(input) +func (c *ForecastService) CreateExplainabilityExportWithContext(ctx aws.Context, input *CreateExplainabilityExportInput, opts ...request.Option) (*CreateExplainabilityExportOutput, error) { + req, out := c.CreateExplainabilityExportRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opCreatePredictor = "CreatePredictor" +const opCreateForecast = "CreateForecast" -// CreatePredictorRequest generates a "aws/request.Request" representing the -// client's request for the CreatePredictor operation. The "output" return +// CreateForecastRequest generates a "aws/request.Request" representing the +// client's request for the CreateForecast operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See CreatePredictor for more information on using the CreatePredictor +// See CreateForecast for more information on using the CreateForecast // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the CreatePredictorRequest method. -// req, resp := client.CreatePredictorRequest(params) +// // Example sending a request using the CreateForecastRequest method. +// req, resp := client.CreateForecastRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictor -func (c *ForecastService) CreatePredictorRequest(input *CreatePredictorInput) (req *request.Request, output *CreatePredictorOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecast +func (c *ForecastService) CreateForecastRequest(input *CreateForecastInput) (req *request.Request, output *CreateForecastOutput) { op := &request.Operation{ - Name: opCreatePredictor, + Name: opCreateForecast, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &CreatePredictorInput{} + input = &CreateForecastInput{} } - output = &CreatePredictorOutput{} + output = &CreateForecastOutput{} req = c.newRequest(op, input, output) return } -// CreatePredictor API operation for Amazon Forecast Service. -// -// Creates an Amazon Forecast predictor. -// -// In the request, provide a dataset group and either specify an algorithm or -// let Amazon Forecast choose an algorithm for you using AutoML. If you specify -// an algorithm, you also can override algorithm-specific hyperparameters. +// CreateForecast API operation for Amazon Forecast Service. // -// Amazon Forecast uses the algorithm to train a predictor using the latest -// version of the datasets in the specified dataset group. You can then generate -// a forecast using the CreateForecast operation. +// Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was +// used to train the predictor. This is known as inference. To retrieve the +// forecast for a single item at low latency, use the operation. To export the +// complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, +// use the CreateForecastExportJob operation. // -// To see the evaluation metrics, use the GetAccuracyMetrics operation. +// The range of the forecast is determined by the ForecastHorizon value, which +// you specify in the CreatePredictor request. When you query a forecast, you +// can request a specific date range within the forecast. // -// You can specify a featurization configuration to fill and aggregate the data -// fields in the TARGET_TIME_SERIES dataset to improve model training. For more -// information, see FeaturizationConfig. +// To get a list of all your forecasts, use the ListForecasts operation. // -// For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency -// specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES -// datasets don't have this restriction. Amazon Forecast also verifies the delimiter -// and timestamp format. For more information, see howitworks-datasets-groups. +// The forecasts generated by Amazon Forecast are in the same time zone as the +// dataset that was used to create the predictor. // -// By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), -// and 0.9 (P90) quantiles. You can choose custom forecast types to train and -// evaluate your predictor by setting the ForecastTypes. +// For more information, see howitworks-forecast. // -// AutoML +// The Status of the forecast must be ACTIVE before you can query or export +// the forecast. Use the DescribeForecast operation to get the status. // -// If you want Amazon Forecast to evaluate each algorithm and choose the one -// that minimizes the objective function, set PerformAutoML to true. The objective -// function is defined as the mean of the weighted losses over the forecast -// types. By default, these are the p10, p50, and p90 quantile losses. For more -// information, see EvaluationResult. +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. // -// When AutoML is enabled, the following properties are disallowed: +// See the AWS API reference guide for Amazon Forecast Service's +// API operation CreateForecast for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// We can't process the request because it includes an invalid value or a value +// that exceeds the valid range. +// +// * ResourceAlreadyExistsException +// There is already a resource with this name. Try again with a different name. +// +// * ResourceNotFoundException +// We can't find a resource with that Amazon Resource Name (ARN). Check the +// ARN and try again. +// +// * ResourceInUseException +// The specified resource is in use. +// +// * LimitExceededException +// The limit on the number of resources per account has been exceeded. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecast +func (c *ForecastService) CreateForecast(input *CreateForecastInput) (*CreateForecastOutput, error) { + req, out := c.CreateForecastRequest(input) + return out, req.Send() +} + +// CreateForecastWithContext is the same as CreateForecast with the addition of +// the ability to pass a context and additional request options. +// +// See CreateForecast for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ForecastService) CreateForecastWithContext(ctx aws.Context, input *CreateForecastInput, opts ...request.Option) (*CreateForecastOutput, error) { + req, out := c.CreateForecastRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateForecastExportJob = "CreateForecastExportJob" + +// CreateForecastExportJobRequest generates a "aws/request.Request" representing the +// client's request for the CreateForecastExportJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateForecastExportJob for more information on using the CreateForecastExportJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateForecastExportJobRequest method. +// req, resp := client.CreateForecastExportJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastExportJob +func (c *ForecastService) CreateForecastExportJobRequest(input *CreateForecastExportJobInput) (req *request.Request, output *CreateForecastExportJobOutput) { + op := &request.Operation{ + Name: opCreateForecastExportJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateForecastExportJobInput{} + } + + output = &CreateForecastExportJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateForecastExportJob API operation for Amazon Forecast Service. +// +// Exports a forecast created by the CreateForecast operation to your Amazon +// Simple Storage Service (Amazon S3) bucket. The forecast file name will match +// the following conventions: +// +// __ +// +// where the component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ). +// +// You must specify a DataDestination object that includes an AWS Identity and +// Access Management (IAM) role that Amazon Forecast can assume to access the +// Amazon S3 bucket. For more information, see aws-forecast-iam-roles. +// +// For more information, see howitworks-forecast. +// +// To get a list of all your forecast export jobs, use the ListForecastExportJobs +// operation. +// +// The Status of the forecast export job must be ACTIVE before you can access +// the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob +// operation. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Forecast Service's +// API operation CreateForecastExportJob for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// We can't process the request because it includes an invalid value or a value +// that exceeds the valid range. +// +// * ResourceAlreadyExistsException +// There is already a resource with this name. Try again with a different name. +// +// * ResourceNotFoundException +// We can't find a resource with that Amazon Resource Name (ARN). Check the +// ARN and try again. +// +// * ResourceInUseException +// The specified resource is in use. +// +// * LimitExceededException +// The limit on the number of resources per account has been exceeded. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreateForecastExportJob +func (c *ForecastService) CreateForecastExportJob(input *CreateForecastExportJobInput) (*CreateForecastExportJobOutput, error) { + req, out := c.CreateForecastExportJobRequest(input) + return out, req.Send() +} + +// CreateForecastExportJobWithContext is the same as CreateForecastExportJob with the addition of +// the ability to pass a context and additional request options. +// +// See CreateForecastExportJob for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ForecastService) CreateForecastExportJobWithContext(ctx aws.Context, input *CreateForecastExportJobInput, opts ...request.Option) (*CreateForecastExportJobOutput, error) { + req, out := c.CreateForecastExportJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreatePredictor = "CreatePredictor" + +// CreatePredictorRequest generates a "aws/request.Request" representing the +// client's request for the CreatePredictor operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreatePredictor for more information on using the CreatePredictor +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreatePredictorRequest method. +// req, resp := client.CreatePredictorRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/CreatePredictor +func (c *ForecastService) CreatePredictorRequest(input *CreatePredictorInput) (req *request.Request, output *CreatePredictorOutput) { + op := &request.Operation{ + Name: opCreatePredictor, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreatePredictorInput{} + } + + output = &CreatePredictorOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreatePredictor API operation for Amazon Forecast Service. +// +// +// This operation creates a legacy predictor that does not include all the predictor +// functionalities provided by Amazon Forecast. To create a predictor that is +// compatible with all aspects of Forecast, use CreateAutoPredictor. +// +// Creates an Amazon Forecast predictor. +// +// In the request, provide a dataset group and either specify an algorithm or +// let Amazon Forecast choose an algorithm for you using AutoML. If you specify +// an algorithm, you also can override algorithm-specific hyperparameters. +// +// Amazon Forecast uses the algorithm to train a predictor using the latest +// version of the datasets in the specified dataset group. You can then generate +// a forecast using the CreateForecast operation. +// +// To see the evaluation metrics, use the GetAccuracyMetrics operation. +// +// You can specify a featurization configuration to fill and aggregate the data +// fields in the TARGET_TIME_SERIES dataset to improve model training. For more +// information, see FeaturizationConfig. +// +// For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the DataFrequency +// specified when the dataset was created matches the ForecastFrequency. TARGET_TIME_SERIES +// datasets don't have this restriction. Amazon Forecast also verifies the delimiter +// and timestamp format. For more information, see howitworks-datasets-groups. +// +// By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), +// and 0.9 (P90) quantiles. You can choose custom forecast types to train and +// evaluate your predictor by setting the ForecastTypes. +// +// AutoML +// +// If you want Amazon Forecast to evaluate each algorithm and choose the one +// that minimizes the objective function, set PerformAutoML to true. The objective +// function is defined as the mean of the weighted losses over the forecast +// types. By default, these are the p10, p50, and p90 quantile losses. For more +// information, see EvaluationResult. +// +// When AutoML is enabled, the following properties are disallowed: // // * AlgorithmArn // @@ -1092,64 +1490,62 @@ func (c *ForecastService) DeleteDatasetImportJobWithContext(ctx aws.Context, inp return out, req.Send() } -const opDeleteForecast = "DeleteForecast" +const opDeleteExplainability = "DeleteExplainability" -// DeleteForecastRequest generates a "aws/request.Request" representing the -// client's request for the DeleteForecast operation. The "output" return +// DeleteExplainabilityRequest generates a "aws/request.Request" representing the +// client's request for the DeleteExplainability operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See DeleteForecast for more information on using the DeleteForecast +// See DeleteExplainability for more information on using the DeleteExplainability // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the DeleteForecastRequest method. -// req, resp := client.DeleteForecastRequest(params) +// // Example sending a request using the DeleteExplainabilityRequest method. +// req, resp := client.DeleteExplainabilityRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecast -func (c *ForecastService) DeleteForecastRequest(input *DeleteForecastInput) (req *request.Request, output *DeleteForecastOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainability +func (c *ForecastService) DeleteExplainabilityRequest(input *DeleteExplainabilityInput) (req *request.Request, output *DeleteExplainabilityOutput) { op := &request.Operation{ - Name: opDeleteForecast, + Name: opDeleteExplainability, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DeleteForecastInput{} + input = &DeleteExplainabilityInput{} } - output = &DeleteForecastOutput{} + output = &DeleteExplainabilityOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DeleteForecast API operation for Amazon Forecast Service. +// DeleteExplainability API operation for Amazon Forecast Service. // -// Deletes a forecast created using the CreateForecast operation. You can delete -// only forecasts that have a status of ACTIVE or CREATE_FAILED. To get the -// status, use the DescribeForecast operation. +// Deletes an Explainability resource. // -// You can't delete a forecast while it is being exported. After a forecast -// is deleted, you can no longer query the forecast. +// You can delete only predictor that have a status of ACTIVE or CREATE_FAILED. +// To get the status, use the DescribeExplainability operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Forecast Service's -// API operation DeleteForecast for usage and error information. +// API operation DeleteExplainability for usage and error information. // // Returned Error Types: // * InvalidInputException @@ -1163,16 +1559,197 @@ func (c *ForecastService) DeleteForecastRequest(input *DeleteForecastInput) (req // * ResourceInUseException // The specified resource is in use. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecast -func (c *ForecastService) DeleteForecast(input *DeleteForecastInput) (*DeleteForecastOutput, error) { - req, out := c.DeleteForecastRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainability +func (c *ForecastService) DeleteExplainability(input *DeleteExplainabilityInput) (*DeleteExplainabilityOutput, error) { + req, out := c.DeleteExplainabilityRequest(input) return out, req.Send() } -// DeleteForecastWithContext is the same as DeleteForecast with the addition of +// DeleteExplainabilityWithContext is the same as DeleteExplainability with the addition of // the ability to pass a context and additional request options. // -// See DeleteForecast for details on how to use this API operation. +// See DeleteExplainability for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ForecastService) DeleteExplainabilityWithContext(ctx aws.Context, input *DeleteExplainabilityInput, opts ...request.Option) (*DeleteExplainabilityOutput, error) { + req, out := c.DeleteExplainabilityRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteExplainabilityExport = "DeleteExplainabilityExport" + +// DeleteExplainabilityExportRequest generates a "aws/request.Request" representing the +// client's request for the DeleteExplainabilityExport operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteExplainabilityExport for more information on using the DeleteExplainabilityExport +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteExplainabilityExportRequest method. +// req, resp := client.DeleteExplainabilityExportRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainabilityExport +func (c *ForecastService) DeleteExplainabilityExportRequest(input *DeleteExplainabilityExportInput) (req *request.Request, output *DeleteExplainabilityExportOutput) { + op := &request.Operation{ + Name: opDeleteExplainabilityExport, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteExplainabilityExportInput{} + } + + output = &DeleteExplainabilityExportOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteExplainabilityExport API operation for Amazon Forecast Service. +// +// Deletes an Explainability export job. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Forecast Service's +// API operation DeleteExplainabilityExport for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// We can't process the request because it includes an invalid value or a value +// that exceeds the valid range. +// +// * ResourceNotFoundException +// We can't find a resource with that Amazon Resource Name (ARN). Check the +// ARN and try again. +// +// * ResourceInUseException +// The specified resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteExplainabilityExport +func (c *ForecastService) DeleteExplainabilityExport(input *DeleteExplainabilityExportInput) (*DeleteExplainabilityExportOutput, error) { + req, out := c.DeleteExplainabilityExportRequest(input) + return out, req.Send() +} + +// DeleteExplainabilityExportWithContext is the same as DeleteExplainabilityExport with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteExplainabilityExport for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ForecastService) DeleteExplainabilityExportWithContext(ctx aws.Context, input *DeleteExplainabilityExportInput, opts ...request.Option) (*DeleteExplainabilityExportOutput, error) { + req, out := c.DeleteExplainabilityExportRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteForecast = "DeleteForecast" + +// DeleteForecastRequest generates a "aws/request.Request" representing the +// client's request for the DeleteForecast operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteForecast for more information on using the DeleteForecast +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteForecastRequest method. +// req, resp := client.DeleteForecastRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecast +func (c *ForecastService) DeleteForecastRequest(input *DeleteForecastInput) (req *request.Request, output *DeleteForecastOutput) { + op := &request.Operation{ + Name: opDeleteForecast, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteForecastInput{} + } + + output = &DeleteForecastOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteForecast API operation for Amazon Forecast Service. +// +// Deletes a forecast created using the CreateForecast operation. You can delete +// only forecasts that have a status of ACTIVE or CREATE_FAILED. To get the +// status, use the DescribeForecast operation. +// +// You can't delete a forecast while it is being exported. After a forecast +// is deleted, you can no longer query the forecast. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Forecast Service's +// API operation DeleteForecast for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// We can't process the request because it includes an invalid value or a value +// that exceeds the valid range. +// +// * ResourceNotFoundException +// We can't find a resource with that Amazon Resource Name (ARN). Check the +// ARN and try again. +// +// * ResourceInUseException +// The specified resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteForecast +func (c *ForecastService) DeleteForecast(input *DeleteForecastInput) (*DeleteForecastOutput, error) { + req, out := c.DeleteForecastRequest(input) + return out, req.Send() +} + +// DeleteForecastWithContext is the same as DeleteForecast with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteForecast for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create @@ -1561,6 +2138,90 @@ func (c *ForecastService) DeleteResourceTreeWithContext(ctx aws.Context, input * return out, req.Send() } +const opDescribeAutoPredictor = "DescribeAutoPredictor" + +// DescribeAutoPredictorRequest generates a "aws/request.Request" representing the +// client's request for the DescribeAutoPredictor operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeAutoPredictor for more information on using the DescribeAutoPredictor +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeAutoPredictorRequest method. +// req, resp := client.DescribeAutoPredictorRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictor +func (c *ForecastService) DescribeAutoPredictorRequest(input *DescribeAutoPredictorInput) (req *request.Request, output *DescribeAutoPredictorOutput) { + op := &request.Operation{ + Name: opDescribeAutoPredictor, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeAutoPredictorInput{} + } + + output = &DescribeAutoPredictorOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeAutoPredictor API operation for Amazon Forecast Service. +// +// Describes a predictor created using the CreateAutoPredictor operation. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Forecast Service's +// API operation DescribeAutoPredictor for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// We can't process the request because it includes an invalid value or a value +// that exceeds the valid range. +// +// * ResourceNotFoundException +// We can't find a resource with that Amazon Resource Name (ARN). Check the +// ARN and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeAutoPredictor +func (c *ForecastService) DescribeAutoPredictor(input *DescribeAutoPredictorInput) (*DescribeAutoPredictorOutput, error) { + req, out := c.DescribeAutoPredictorRequest(input) + return out, req.Send() +} + +// DescribeAutoPredictorWithContext is the same as DescribeAutoPredictor with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeAutoPredictor for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ForecastService) DescribeAutoPredictorWithContext(ctx aws.Context, input *DescribeAutoPredictorInput, opts ...request.Option) (*DescribeAutoPredictorOutput, error) { + req, out := c.DescribeAutoPredictorRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeDataset = "DescribeDataset" // DescribeDatasetRequest generates a "aws/request.Request" representing the @@ -1848,71 +2509,59 @@ func (c *ForecastService) DescribeDatasetImportJobWithContext(ctx aws.Context, i return out, req.Send() } -const opDescribeForecast = "DescribeForecast" +const opDescribeExplainability = "DescribeExplainability" -// DescribeForecastRequest generates a "aws/request.Request" representing the -// client's request for the DescribeForecast operation. The "output" return +// DescribeExplainabilityRequest generates a "aws/request.Request" representing the +// client's request for the DescribeExplainability operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See DescribeForecast for more information on using the DescribeForecast +// See DescribeExplainability for more information on using the DescribeExplainability // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the DescribeForecastRequest method. -// req, resp := client.DescribeForecastRequest(params) +// // Example sending a request using the DescribeExplainabilityRequest method. +// req, resp := client.DescribeExplainabilityRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecast -func (c *ForecastService) DescribeForecastRequest(input *DescribeForecastInput) (req *request.Request, output *DescribeForecastOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainability +func (c *ForecastService) DescribeExplainabilityRequest(input *DescribeExplainabilityInput) (req *request.Request, output *DescribeExplainabilityOutput) { op := &request.Operation{ - Name: opDescribeForecast, + Name: opDescribeExplainability, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DescribeForecastInput{} + input = &DescribeExplainabilityInput{} } - output = &DescribeForecastOutput{} + output = &DescribeExplainabilityOutput{} req = c.newRequest(op, input, output) return } -// DescribeForecast API operation for Amazon Forecast Service. -// -// Describes a forecast created using the CreateForecast operation. -// -// In addition to listing the properties provided in the CreateForecast request, -// this operation lists the following properties: -// -// * DatasetGroupArn - The dataset group that provided the training data. +// DescribeExplainability API operation for Amazon Forecast Service. // -// * CreationTime -// -// * LastModificationTime -// -// * Status -// -// * Message - If an error occurred, information about the error. +// Describes an Explainability resource created using the CreateExplainability +// operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Forecast Service's -// API operation DescribeForecast for usage and error information. +// API operation DescribeExplainability for usage and error information. // // Returned Error Types: // * InvalidInputException @@ -1923,23 +2572,205 @@ func (c *ForecastService) DescribeForecastRequest(input *DescribeForecastInput) // We can't find a resource with that Amazon Resource Name (ARN). Check the // ARN and try again. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecast -func (c *ForecastService) DescribeForecast(input *DescribeForecastInput) (*DescribeForecastOutput, error) { - req, out := c.DescribeForecastRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainability +func (c *ForecastService) DescribeExplainability(input *DescribeExplainabilityInput) (*DescribeExplainabilityOutput, error) { + req, out := c.DescribeExplainabilityRequest(input) return out, req.Send() } -// DescribeForecastWithContext is the same as DescribeForecast with the addition of +// DescribeExplainabilityWithContext is the same as DescribeExplainability with the addition of // the ability to pass a context and additional request options. // -// See DescribeForecast for details on how to use this API operation. +// See DescribeExplainability for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *ForecastService) DescribeForecastWithContext(ctx aws.Context, input *DescribeForecastInput, opts ...request.Option) (*DescribeForecastOutput, error) { - req, out := c.DescribeForecastRequest(input) +func (c *ForecastService) DescribeExplainabilityWithContext(ctx aws.Context, input *DescribeExplainabilityInput, opts ...request.Option) (*DescribeExplainabilityOutput, error) { + req, out := c.DescribeExplainabilityRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeExplainabilityExport = "DescribeExplainabilityExport" + +// DescribeExplainabilityExportRequest generates a "aws/request.Request" representing the +// client's request for the DescribeExplainabilityExport operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeExplainabilityExport for more information on using the DescribeExplainabilityExport +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeExplainabilityExportRequest method. +// req, resp := client.DescribeExplainabilityExportRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityExport +func (c *ForecastService) DescribeExplainabilityExportRequest(input *DescribeExplainabilityExportInput) (req *request.Request, output *DescribeExplainabilityExportOutput) { + op := &request.Operation{ + Name: opDescribeExplainabilityExport, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeExplainabilityExportInput{} + } + + output = &DescribeExplainabilityExportOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeExplainabilityExport API operation for Amazon Forecast Service. +// +// Describes an Explainability export created using the CreateExplainabilityExport +// operation. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Forecast Service's +// API operation DescribeExplainabilityExport for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// We can't process the request because it includes an invalid value or a value +// that exceeds the valid range. +// +// * ResourceNotFoundException +// We can't find a resource with that Amazon Resource Name (ARN). Check the +// ARN and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeExplainabilityExport +func (c *ForecastService) DescribeExplainabilityExport(input *DescribeExplainabilityExportInput) (*DescribeExplainabilityExportOutput, error) { + req, out := c.DescribeExplainabilityExportRequest(input) + return out, req.Send() +} + +// DescribeExplainabilityExportWithContext is the same as DescribeExplainabilityExport with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeExplainabilityExport for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ForecastService) DescribeExplainabilityExportWithContext(ctx aws.Context, input *DescribeExplainabilityExportInput, opts ...request.Option) (*DescribeExplainabilityExportOutput, error) { + req, out := c.DescribeExplainabilityExportRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeForecast = "DescribeForecast" + +// DescribeForecastRequest generates a "aws/request.Request" representing the +// client's request for the DescribeForecast operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeForecast for more information on using the DescribeForecast +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeForecastRequest method. +// req, resp := client.DescribeForecastRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecast +func (c *ForecastService) DescribeForecastRequest(input *DescribeForecastInput) (req *request.Request, output *DescribeForecastOutput) { + op := &request.Operation{ + Name: opDescribeForecast, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeForecastInput{} + } + + output = &DescribeForecastOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeForecast API operation for Amazon Forecast Service. +// +// Describes a forecast created using the CreateForecast operation. +// +// In addition to listing the properties provided in the CreateForecast request, +// this operation lists the following properties: +// +// * DatasetGroupArn - The dataset group that provided the training data. +// +// * CreationTime +// +// * LastModificationTime +// +// * Status +// +// * Message - If an error occurred, information about the error. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Forecast Service's +// API operation DescribeForecast for usage and error information. +// +// Returned Error Types: +// * InvalidInputException +// We can't process the request because it includes an invalid value or a value +// that exceeds the valid range. +// +// * ResourceNotFoundException +// We can't find a resource with that Amazon Resource Name (ARN). Check the +// ARN and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeForecast +func (c *ForecastService) DescribeForecast(input *DescribeForecastInput) (*DescribeForecastOutput, error) { + req, out := c.DescribeForecastRequest(input) + return out, req.Send() +} + +// DescribeForecastWithContext is the same as DescribeForecast with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeForecast for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ForecastService) DescribeForecastWithContext(ctx aws.Context, input *DescribeForecastInput, opts ...request.Option) (*DescribeForecastOutput, error) { + req, out := c.DescribeForecastRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() @@ -2085,6 +2916,12 @@ func (c *ForecastService) DescribePredictorRequest(input *DescribePredictorInput // DescribePredictor API operation for Amazon Forecast Service. // +// +// This operation is only valid for legacy predictors created with CreatePredictor. +// If you are not using a legacy predictor, use DescribeAutoPredictor. +// +// To upgrade a legacy predictor to AutoPredictor, see Upgrading to AutoPredictor. +// // Describes a predictor created using the CreatePredictor operation. // // In addition to listing the properties provided in the CreatePredictor request, @@ -2769,68 +3606,63 @@ func (c *ForecastService) ListDatasetsPagesWithContext(ctx aws.Context, input *L return p.Err() } -const opListForecastExportJobs = "ListForecastExportJobs" +const opListExplainabilities = "ListExplainabilities" -// ListForecastExportJobsRequest generates a "aws/request.Request" representing the -// client's request for the ListForecastExportJobs operation. The "output" return +// ListExplainabilitiesRequest generates a "aws/request.Request" representing the +// client's request for the ListExplainabilities operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListForecastExportJobs for more information on using the ListForecastExportJobs +// See ListExplainabilities for more information on using the ListExplainabilities // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the ListForecastExportJobsRequest method. -// req, resp := client.ListForecastExportJobsRequest(params) +// // Example sending a request using the ListExplainabilitiesRequest method. +// req, resp := client.ListExplainabilitiesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecastExportJobs -func (c *ForecastService) ListForecastExportJobsRequest(input *ListForecastExportJobsInput) (req *request.Request, output *ListForecastExportJobsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilities +func (c *ForecastService) ListExplainabilitiesRequest(input *ListExplainabilitiesInput) (req *request.Request, output *ListExplainabilitiesOutput) { op := &request.Operation{ - Name: opListForecastExportJobs, + Name: opListExplainabilities, HTTPMethod: "POST", HTTPPath: "/", - Paginator: &request.Paginator{ - InputTokens: []string{"NextToken"}, - OutputTokens: []string{"NextToken"}, - LimitToken: "MaxResults", - TruncationToken: "", - }, } if input == nil { - input = &ListForecastExportJobsInput{} + input = &ListExplainabilitiesInput{} } - output = &ListForecastExportJobsOutput{} + output = &ListExplainabilitiesOutput{} req = c.newRequest(op, input, output) return } -// ListForecastExportJobs API operation for Amazon Forecast Service. +// ListExplainabilities API operation for Amazon Forecast Service. // -// Returns a list of forecast export jobs created using the CreateForecastExportJob -// operation. For each forecast export job, this operation returns a summary -// of its properties, including its Amazon Resource Name (ARN). To retrieve -// the complete set of properties, use the ARN with the DescribeForecastExportJob -// operation. You can filter the list using an array of Filter objects. +// Returns a list of Explainability resources created using the CreateExplainability +// operation. This operation returns a summary for each Explainability. You +// can filter the list using an array of Filter objects. +// +// To retrieve the complete set of properties for a particular Explainability +// resource, use the ARN with the DescribeExplainability operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for Amazon Forecast Service's -// API operation ListForecastExportJobs for usage and error information. +// API operation ListExplainabilities for usage and error information. // // Returned Error Types: // * InvalidNextTokenException @@ -2840,107 +3672,288 @@ func (c *ForecastService) ListForecastExportJobsRequest(input *ListForecastExpor // We can't process the request because it includes an invalid value or a value // that exceeds the valid range. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecastExportJobs -func (c *ForecastService) ListForecastExportJobs(input *ListForecastExportJobsInput) (*ListForecastExportJobsOutput, error) { - req, out := c.ListForecastExportJobsRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilities +func (c *ForecastService) ListExplainabilities(input *ListExplainabilitiesInput) (*ListExplainabilitiesOutput, error) { + req, out := c.ListExplainabilitiesRequest(input) return out, req.Send() } -// ListForecastExportJobsWithContext is the same as ListForecastExportJobs with the addition of +// ListExplainabilitiesWithContext is the same as ListExplainabilities with the addition of // the ability to pass a context and additional request options. // -// See ListForecastExportJobs for details on how to use this API operation. +// See ListExplainabilities for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *ForecastService) ListForecastExportJobsWithContext(ctx aws.Context, input *ListForecastExportJobsInput, opts ...request.Option) (*ListForecastExportJobsOutput, error) { - req, out := c.ListForecastExportJobsRequest(input) +func (c *ForecastService) ListExplainabilitiesWithContext(ctx aws.Context, input *ListExplainabilitiesInput, opts ...request.Option) (*ListExplainabilitiesOutput, error) { + req, out := c.ListExplainabilitiesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListForecastExportJobsPages iterates over the pages of a ListForecastExportJobs operation, -// calling the "fn" function with the response data for each page. To stop -// iterating, return false from the fn function. -// -// See ListForecastExportJobs method for more information on how to use this operation. -// -// Note: This operation can generate multiple requests to a service. -// -// // Example iterating over at most 3 pages of a ListForecastExportJobs operation. -// pageNum := 0 -// err := client.ListForecastExportJobsPages(params, -// func(page *forecastservice.ListForecastExportJobsOutput, lastPage bool) bool { -// pageNum++ -// fmt.Println(page) -// return pageNum <= 3 -// }) -// -func (c *ForecastService) ListForecastExportJobsPages(input *ListForecastExportJobsInput, fn func(*ListForecastExportJobsOutput, bool) bool) error { - return c.ListForecastExportJobsPagesWithContext(aws.BackgroundContext(), input, fn) -} - -// ListForecastExportJobsPagesWithContext same as ListForecastExportJobsPages except -// it takes a Context and allows setting request options on the pages. -// -// The context must be non-nil and will be used for request cancellation. If -// the context is nil a panic will occur. In the future the SDK may create -// sub-contexts for http.Requests. See https://golang.org/pkg/context/ -// for more information on using Contexts. -func (c *ForecastService) ListForecastExportJobsPagesWithContext(ctx aws.Context, input *ListForecastExportJobsInput, fn func(*ListForecastExportJobsOutput, bool) bool, opts ...request.Option) error { - p := request.Pagination{ - NewRequest: func() (*request.Request, error) { - var inCpy *ListForecastExportJobsInput - if input != nil { - tmp := *input - inCpy = &tmp - } - req, _ := c.ListForecastExportJobsRequest(inCpy) - req.SetContext(ctx) - req.ApplyOptions(opts...) - return req, nil - }, - } - - for p.Next() { - if !fn(p.Page().(*ListForecastExportJobsOutput), !p.HasNextPage()) { - break - } - } - - return p.Err() -} - -const opListForecasts = "ListForecasts" +const opListExplainabilityExports = "ListExplainabilityExports" -// ListForecastsRequest generates a "aws/request.Request" representing the -// client's request for the ListForecasts operation. The "output" return +// ListExplainabilityExportsRequest generates a "aws/request.Request" representing the +// client's request for the ListExplainabilityExports operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListForecasts for more information on using the ListForecasts +// See ListExplainabilityExports for more information on using the ListExplainabilityExports // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the ListForecastsRequest method. -// req, resp := client.ListForecastsRequest(params) +// // Example sending a request using the ListExplainabilityExportsRequest method. +// req, resp := client.ListExplainabilityExportsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecasts -func (c *ForecastService) ListForecastsRequest(input *ListForecastsInput) (req *request.Request, output *ListForecastsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilityExports +func (c *ForecastService) ListExplainabilityExportsRequest(input *ListExplainabilityExportsInput) (req *request.Request, output *ListExplainabilityExportsOutput) { + op := &request.Operation{ + Name: opListExplainabilityExports, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ListExplainabilityExportsInput{} + } + + output = &ListExplainabilityExportsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListExplainabilityExports API operation for Amazon Forecast Service. +// +// Returns a list of Explainability exports created using the CreateExplainabilityExport +// operation. This operation returns a summary for each Explainability export. +// You can filter the list using an array of Filter objects. +// +// To retrieve the complete set of properties for a particular Explainability +// export, use the ARN with the DescribeExplainability operation. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Forecast Service's +// API operation ListExplainabilityExports for usage and error information. +// +// Returned Error Types: +// * InvalidNextTokenException +// The token is not valid. Tokens expire after 24 hours. +// +// * InvalidInputException +// We can't process the request because it includes an invalid value or a value +// that exceeds the valid range. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListExplainabilityExports +func (c *ForecastService) ListExplainabilityExports(input *ListExplainabilityExportsInput) (*ListExplainabilityExportsOutput, error) { + req, out := c.ListExplainabilityExportsRequest(input) + return out, req.Send() +} + +// ListExplainabilityExportsWithContext is the same as ListExplainabilityExports with the addition of +// the ability to pass a context and additional request options. +// +// See ListExplainabilityExports for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ForecastService) ListExplainabilityExportsWithContext(ctx aws.Context, input *ListExplainabilityExportsInput, opts ...request.Option) (*ListExplainabilityExportsOutput, error) { + req, out := c.ListExplainabilityExportsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListForecastExportJobs = "ListForecastExportJobs" + +// ListForecastExportJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListForecastExportJobs operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListForecastExportJobs for more information on using the ListForecastExportJobs +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListForecastExportJobsRequest method. +// req, resp := client.ListForecastExportJobsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecastExportJobs +func (c *ForecastService) ListForecastExportJobsRequest(input *ListForecastExportJobsInput) (req *request.Request, output *ListForecastExportJobsOutput) { + op := &request.Operation{ + Name: opListForecastExportJobs, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListForecastExportJobsInput{} + } + + output = &ListForecastExportJobsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListForecastExportJobs API operation for Amazon Forecast Service. +// +// Returns a list of forecast export jobs created using the CreateForecastExportJob +// operation. For each forecast export job, this operation returns a summary +// of its properties, including its Amazon Resource Name (ARN). To retrieve +// the complete set of properties, use the ARN with the DescribeForecastExportJob +// operation. You can filter the list using an array of Filter objects. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Forecast Service's +// API operation ListForecastExportJobs for usage and error information. +// +// Returned Error Types: +// * InvalidNextTokenException +// The token is not valid. Tokens expire after 24 hours. +// +// * InvalidInputException +// We can't process the request because it includes an invalid value or a value +// that exceeds the valid range. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecastExportJobs +func (c *ForecastService) ListForecastExportJobs(input *ListForecastExportJobsInput) (*ListForecastExportJobsOutput, error) { + req, out := c.ListForecastExportJobsRequest(input) + return out, req.Send() +} + +// ListForecastExportJobsWithContext is the same as ListForecastExportJobs with the addition of +// the ability to pass a context and additional request options. +// +// See ListForecastExportJobs for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ForecastService) ListForecastExportJobsWithContext(ctx aws.Context, input *ListForecastExportJobsInput, opts ...request.Option) (*ListForecastExportJobsOutput, error) { + req, out := c.ListForecastExportJobsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListForecastExportJobsPages iterates over the pages of a ListForecastExportJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListForecastExportJobs method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListForecastExportJobs operation. +// pageNum := 0 +// err := client.ListForecastExportJobsPages(params, +// func(page *forecastservice.ListForecastExportJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *ForecastService) ListForecastExportJobsPages(input *ListForecastExportJobsInput, fn func(*ListForecastExportJobsOutput, bool) bool) error { + return c.ListForecastExportJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListForecastExportJobsPagesWithContext same as ListForecastExportJobsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *ForecastService) ListForecastExportJobsPagesWithContext(ctx aws.Context, input *ListForecastExportJobsInput, fn func(*ListForecastExportJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListForecastExportJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListForecastExportJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListForecastExportJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListForecasts = "ListForecasts" + +// ListForecastsRequest generates a "aws/request.Request" representing the +// client's request for the ListForecasts operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListForecasts for more information on using the ListForecasts +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListForecastsRequest method. +// req, resp := client.ListForecastsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListForecasts +func (c *ForecastService) ListForecastsRequest(input *ListForecastsInput) (req *request.Request, output *ListForecastsOutput) { op := &request.Operation{ Name: opListForecasts, HTTPMethod: "POST", @@ -3806,55 +4819,201 @@ func (c *ForecastService) UpdateDatasetGroupWithContext(ctx aws.Context, input * return out, req.Send() } -// Specifies a categorical hyperparameter and it's range of tunable values. -// This object is part of the ParameterRanges object. -type CategoricalParameterRange struct { +// Describes an additional dataset. This object is part of the DataConfig object. +// Forecast supports the Weather Index and Holidays additional datasets. +// +// Weather Index +// +// The Amazon Forecast Weather Index is a built-in dataset that incorporates +// historical and projected weather information into your model. The Weather +// Index supplements your datasets with over two years of historical weather +// data and up to 14 days of projected weather data. For more information, see +// Amazon Forecast Weather Index (https://docs.aws.amazon.com/forecast/latest/dg/weather.html). +// +// Holidays +// +// Holidays is a built-in dataset that incorporates national holiday information +// into your model. It provides native support for the holiday calendars of +// 66 countries. To view the holiday calendars, refer to the Jollyday (http://jollyday.sourceforge.net/data.html) +// library. For more information, see Holidays Featurization (https://docs.aws.amazon.com/forecast/latest/dg/holidays.html). +type AdditionalDataset struct { _ struct{} `type:"structure"` - // The name of the categorical hyperparameter to tune. + // Weather Index // - // Name is a required field - Name *string `min:"1" type:"string" required:"true"` - - // A list of the tunable categories for the hyperparameter. + // To enable the Weather Index, do not specify a value for Configuration. // - // Values is a required field - Values []*string `min:"1" type:"list" required:"true"` -} - -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s CategoricalParameterRange) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s CategoricalParameterRange) GoString() string { - return s.String() + // Holidays + // + // To enable Holidays, specify a country with one of the following two-letter + // country codes: + // + // * "AL" - ALBANIA + // + // * "AR" - ARGENTINA + // + // * "AT" - AUSTRIA + // + // * "AU" - AUSTRALIA + // + // * "BA" - BOSNIA HERZEGOVINA + // + // * "BE" - BELGIUM + // + // * "BG" - BULGARIA + // + // * "BO" - BOLIVIA + // + // * "BR" - BRAZIL + // + // * "BY" - BELARUS + // + // * "CA" - CANADA + // + // * "CL" - CHILE + // + // * "CO" - COLOMBIA + // + // * "CR" - COSTA RICA + // + // * "HR" - CROATIA + // + // * "CZ" - CZECH REPUBLIC + // + // * "DK" - DENMARK + // + // * "EC" - ECUADOR + // + // * "EE" - ESTONIA + // + // * "ET" - ETHIOPIA + // + // * "FI" - FINLAND + // + // * "FR" - FRANCE + // + // * "DE" - GERMANY + // + // * "GR" - GREECE + // + // * "HU" - HUNGARY + // + // * "IS" - ICELAND + // + // * "IN" - INDIA + // + // * "IE" - IRELAND + // + // * "IT" - ITALY + // + // * "JP" - JAPAN + // + // * "KZ" - KAZAKHSTAN + // + // * "KR" - KOREA + // + // * "LV" - LATVIA + // + // * "LI" - LIECHTENSTEIN + // + // * "LT" - LITHUANIA + // + // * "LU" - LUXEMBOURG + // + // * "MK" - MACEDONIA + // + // * "MT" - MALTA + // + // * "MX" - MEXICO + // + // * "MD" - MOLDOVA + // + // * "ME" - MONTENEGRO + // + // * "NL" - NETHERLANDS + // + // * "NZ" - NEW ZEALAND + // + // * "NI" - NICARAGUA + // + // * "NG" - NIGERIA + // + // * "NO" - NORWAY + // + // * "PA" - PANAMA + // + // * "PY" - PARAGUAY + // + // * "PE" - PERU + // + // * "PL" - POLAND + // + // * "PT" - PORTUGAL + // + // * "RO" - ROMANIA + // + // * "RU" - RUSSIA + // + // * "RS" - SERBIA + // + // * "SK" - SLOVAKIA + // + // * "SI" - SLOVENIA + // + // * "ZA" - SOUTH AFRICA + // + // * "ES" - SPAIN + // + // * "SE" - SWEDEN + // + // * "CH" - SWITZERLAND + // + // * "UA" - UKRAINE + // + // * "AE" - UNITED ARAB EMIRATES + // + // * "US" - UNITED STATES + // + // * "UK" - UNITED KINGDOM + // + // * "UY" - URUGUAY + // + // * "VE" - VENEZUELA + Configuration map[string][]*string `type:"map"` + + // The name of the additional dataset. Valid names: "holiday" and "weather". + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AdditionalDataset) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AdditionalDataset) GoString() string { + return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CategoricalParameterRange) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CategoricalParameterRange"} +func (s *AdditionalDataset) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AdditionalDataset"} if s.Name == nil { invalidParams.Add(request.NewErrParamRequired("Name")) } if s.Name != nil && len(*s.Name) < 1 { invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } - if s.Values == nil { - invalidParams.Add(request.NewErrParamRequired("Values")) - } - if s.Values != nil && len(s.Values) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Values", 1)) - } if invalidParams.Len() > 0 { return invalidParams @@ -3862,69 +5021,72 @@ func (s *CategoricalParameterRange) Validate() error { return nil } -// SetName sets the Name field's value. -func (s *CategoricalParameterRange) SetName(v string) *CategoricalParameterRange { - s.Name = &v +// SetConfiguration sets the Configuration field's value. +func (s *AdditionalDataset) SetConfiguration(v map[string][]*string) *AdditionalDataset { + s.Configuration = v return s } -// SetValues sets the Values field's value. -func (s *CategoricalParameterRange) SetValues(v []*string) *CategoricalParameterRange { - s.Values = v +// SetName sets the Name field's value. +func (s *AdditionalDataset) SetName(v string) *AdditionalDataset { + s.Name = &v return s } -// Specifies a continuous hyperparameter and it's range of tunable values. This -// object is part of the ParameterRanges object. -type ContinuousParameterRange struct { +// Provides information about the method used to transform attributes. +// +// The following is an example using the RETAIL domain: +// +// { +// +// "AttributeName": "demand", +// +// "Transformations": {"aggregation": "sum", "middlefill": "zero", "backfill": +// "zero"} +// +// } +type AttributeConfig struct { _ struct{} `type:"structure"` - // The maximum tunable value of the hyperparameter. - // - // MaxValue is a required field - MaxValue *float64 `type:"double" required:"true"` - - // The minimum tunable value of the hyperparameter. - // - // MinValue is a required field - MinValue *float64 `type:"double" required:"true"` - - // The name of the hyperparameter to tune. + // The name of the attribute as specified in the schema. Amazon Forecast supports + // the target field of the target time series and the related time series datasets. + // For example, for the RETAIL domain, the target is demand. // - // Name is a required field - Name *string `min:"1" type:"string" required:"true"` + // AttributeName is a required field + AttributeName *string `min:"1" type:"string" required:"true"` - // The scale that hyperparameter tuning uses to search the hyperparameter range. - // Valid values: + // The method parameters (key-value pairs), which are a map of override parameters. + // Specify these parameters to override the default values. Related Time Series + // attributes do not accept aggregation parameters. // - // Auto + // The following list shows the parameters and their valid values for the "filling" + // featurization method for a Target Time Series dataset. Default values are + // bolded. // - // Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter. + // * aggregation: sum, avg, first, min, max // - // Linear + // * frontfill: none // - // Hyperparameter tuning searches the values in the hyperparameter range by - // using a linear scale. + // * middlefill: zero, nan (not a number), value, median, mean, min, max // - // Logarithmic + // * backfill: zero, nan, value, median, mean, min, max // - // Hyperparameter tuning searches the values in the hyperparameter range by - // using a logarithmic scale. + // The following list shows the parameters and their valid values for a Related + // Time Series featurization method (there are no defaults): // - // Logarithmic scaling works only for ranges that have values greater than 0. + // * middlefill: zero, value, median, mean, min, max // - // ReverseLogarithmic + // * backfill: zero, value, median, mean, min, max // - // hyperparameter tuning searches the values in the hyperparameter range by - // using a reverse logarithmic scale. + // * futurefill: zero, value, median, mean, min, max // - // Reverse logarithmic scaling works only for ranges that are entirely within - // the range 0 <= x < 1.0. + // To set a filling method to a specific value, set the fill parameter to value + // and define the value in a corresponding _value parameter. For example, to + // set backfilling to a value of 2, include the following: "backfill": "value" + // and "backfill_value":"2". // - // For information about choosing a hyperparameter scale, see Hyperparameter - // Scaling (http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). - // One of the following values: - ScalingType *string `type:"string" enum:"ScalingType"` + // Transformations is a required field + Transformations map[string]*string `min:"1" type:"map" required:"true"` } // String returns the string representation. @@ -3932,7 +5094,7 @@ type ContinuousParameterRange struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ContinuousParameterRange) String() string { +func (s AttributeConfig) String() string { return awsutil.Prettify(s) } @@ -3941,24 +5103,24 @@ func (s ContinuousParameterRange) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ContinuousParameterRange) GoString() string { +func (s AttributeConfig) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ContinuousParameterRange) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ContinuousParameterRange"} - if s.MaxValue == nil { - invalidParams.Add(request.NewErrParamRequired("MaxValue")) +func (s *AttributeConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AttributeConfig"} + if s.AttributeName == nil { + invalidParams.Add(request.NewErrParamRequired("AttributeName")) } - if s.MinValue == nil { - invalidParams.Add(request.NewErrParamRequired("MinValue")) + if s.AttributeName != nil && len(*s.AttributeName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AttributeName", 1)) } - if s.Name == nil { - invalidParams.Add(request.NewErrParamRequired("Name")) + if s.Transformations == nil { + invalidParams.Add(request.NewErrParamRequired("Transformations")) } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + if s.Transformations != nil && len(s.Transformations) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Transformations", 1)) } if invalidParams.Len() > 0 { @@ -3967,85 +5129,137 @@ func (s *ContinuousParameterRange) Validate() error { return nil } -// SetMaxValue sets the MaxValue field's value. -func (s *ContinuousParameterRange) SetMaxValue(v float64) *ContinuousParameterRange { - s.MaxValue = &v +// SetAttributeName sets the AttributeName field's value. +func (s *AttributeConfig) SetAttributeName(v string) *AttributeConfig { + s.AttributeName = &v return s } -// SetMinValue sets the MinValue field's value. -func (s *ContinuousParameterRange) SetMinValue(v float64) *ContinuousParameterRange { - s.MinValue = &v +// SetTransformations sets the Transformations field's value. +func (s *AttributeConfig) SetTransformations(v map[string]*string) *AttributeConfig { + s.Transformations = v return s } +// Specifies a categorical hyperparameter and it's range of tunable values. +// This object is part of the ParameterRanges object. +type CategoricalParameterRange struct { + _ struct{} `type:"structure"` + + // The name of the categorical hyperparameter to tune. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // A list of the tunable categories for the hyperparameter. + // + // Values is a required field + Values []*string `min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CategoricalParameterRange) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CategoricalParameterRange) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CategoricalParameterRange) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CategoricalParameterRange"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.Values == nil { + invalidParams.Add(request.NewErrParamRequired("Values")) + } + if s.Values != nil && len(s.Values) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Values", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + // SetName sets the Name field's value. -func (s *ContinuousParameterRange) SetName(v string) *ContinuousParameterRange { +func (s *CategoricalParameterRange) SetName(v string) *CategoricalParameterRange { s.Name = &v return s } -// SetScalingType sets the ScalingType field's value. -func (s *ContinuousParameterRange) SetScalingType(v string) *ContinuousParameterRange { - s.ScalingType = &v +// SetValues sets the Values field's value. +func (s *CategoricalParameterRange) SetValues(v []*string) *CategoricalParameterRange { + s.Values = v return s } -type CreateDatasetGroupInput struct { +// Specifies a continuous hyperparameter and it's range of tunable values. This +// object is part of the ParameterRanges object. +type ContinuousParameterRange struct { _ struct{} `type:"structure"` - // An array of Amazon Resource Names (ARNs) of the datasets that you want to - // include in the dataset group. - DatasetArns []*string `type:"list"` - - // A name for the dataset group. + // The maximum tunable value of the hyperparameter. // - // DatasetGroupName is a required field - DatasetGroupName *string `min:"1" type:"string" required:"true"` + // MaxValue is a required field + MaxValue *float64 `type:"double" required:"true"` - // The domain associated with the dataset group. When you add a dataset to a - // dataset group, this value and the value specified for the Domain parameter - // of the CreateDataset operation must match. + // The minimum tunable value of the hyperparameter. // - // The Domain and DatasetType that you choose determine the fields that must - // be present in training data that you import to a dataset. For example, if - // you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon - // Forecast requires that item_id, timestamp, and demand fields are present - // in your data. For more information, see howitworks-datasets-groups. + // MinValue is a required field + MinValue *float64 `type:"double" required:"true"` + + // The name of the hyperparameter to tune. // - // Domain is a required field - Domain *string `type:"string" required:"true" enum:"Domain"` + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` - // The optional metadata that you apply to the dataset group to help you categorize - // and organize them. Each tag consists of a key and an optional value, both - // of which you define. + // The scale that hyperparameter tuning uses to search the hyperparameter range. + // Valid values: // - // The following basic restrictions apply to tags: + // Auto // - // * Maximum number of tags per resource - 50. + // Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter. // - // * For each resource, each tag key must be unique, and each tag key can - // have only one value. + // Linear // - // * Maximum key length - 128 Unicode characters in UTF-8. + // Hyperparameter tuning searches the values in the hyperparameter range by + // using a linear scale. // - // * Maximum value length - 256 Unicode characters in UTF-8. + // Logarithmic // - // * If your tagging schema is used across multiple services and resources, - // remember that other services may have restrictions on allowed characters. - // Generally allowed characters are: letters, numbers, and spaces representable - // in UTF-8, and the following characters: + - = . _ : / @. + // Hyperparameter tuning searches the values in the hyperparameter range by + // using a logarithmic scale. // - // * Tag keys and values are case sensitive. + // Logarithmic scaling works only for ranges that have values greater than 0. // - // * Do not use aws:, AWS:, or any upper or lowercase combination of such - // as a prefix for keys as it is reserved for AWS use. You cannot edit or - // delete tag keys with this prefix. Values can have this prefix. If a tag - // value has aws as its prefix but the key does not, then Forecast considers - // it to be a user tag and will count against the limit of 50 tags. Tags - // with only the key prefix of aws do not count against your tags per resource - // limit. - Tags []*Tag `type:"list"` + // ReverseLogarithmic + // + // hyperparameter tuning searches the values in the hyperparameter range by + // using a reverse logarithmic scale. + // + // Reverse logarithmic scaling works only for ranges that are entirely within + // the range 0 <= x < 1.0. + // + // For information about choosing a hyperparameter scale, see Hyperparameter + // Scaling (http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). + // One of the following values: + ScalingType *string `type:"string" enum:"ScalingType"` } // String returns the string representation. @@ -4053,7 +5267,7 @@ type CreateDatasetGroupInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateDatasetGroupInput) String() string { +func (s ContinuousParameterRange) String() string { return awsutil.Prettify(s) } @@ -4062,31 +5276,24 @@ func (s CreateDatasetGroupInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateDatasetGroupInput) GoString() string { +func (s ContinuousParameterRange) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateDatasetGroupInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateDatasetGroupInput"} - if s.DatasetGroupName == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetGroupName")) +func (s *ContinuousParameterRange) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ContinuousParameterRange"} + if s.MaxValue == nil { + invalidParams.Add(request.NewErrParamRequired("MaxValue")) } - if s.DatasetGroupName != nil && len(*s.DatasetGroupName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatasetGroupName", 1)) + if s.MinValue == nil { + invalidParams.Add(request.NewErrParamRequired("MinValue")) } - if s.Domain == nil { - invalidParams.Add(request.NewErrParamRequired("Domain")) + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) } - if s.Tags != nil { - for i, v := range s.Tags { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) - } - } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) } if invalidParams.Len() > 0 { @@ -4095,154 +5302,118 @@ func (s *CreateDatasetGroupInput) Validate() error { return nil } -// SetDatasetArns sets the DatasetArns field's value. -func (s *CreateDatasetGroupInput) SetDatasetArns(v []*string) *CreateDatasetGroupInput { - s.DatasetArns = v +// SetMaxValue sets the MaxValue field's value. +func (s *ContinuousParameterRange) SetMaxValue(v float64) *ContinuousParameterRange { + s.MaxValue = &v return s } -// SetDatasetGroupName sets the DatasetGroupName field's value. -func (s *CreateDatasetGroupInput) SetDatasetGroupName(v string) *CreateDatasetGroupInput { - s.DatasetGroupName = &v +// SetMinValue sets the MinValue field's value. +func (s *ContinuousParameterRange) SetMinValue(v float64) *ContinuousParameterRange { + s.MinValue = &v return s } -// SetDomain sets the Domain field's value. -func (s *CreateDatasetGroupInput) SetDomain(v string) *CreateDatasetGroupInput { - s.Domain = &v +// SetName sets the Name field's value. +func (s *ContinuousParameterRange) SetName(v string) *ContinuousParameterRange { + s.Name = &v return s } -// SetTags sets the Tags field's value. -func (s *CreateDatasetGroupInput) SetTags(v []*Tag) *CreateDatasetGroupInput { - s.Tags = v +// SetScalingType sets the ScalingType field's value. +func (s *ContinuousParameterRange) SetScalingType(v string) *ContinuousParameterRange { + s.ScalingType = &v return s } -type CreateDatasetGroupOutput struct { +type CreateAutoPredictorInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset group. - DatasetGroupArn *string `type:"string"` -} - -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s CreateDatasetGroupOutput) String() string { - return awsutil.Prettify(s) -} + // The data configuration for your dataset group and any additional datasets. + DataConfig *DataConfig `type:"structure"` -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s CreateDatasetGroupOutput) GoString() string { - return s.String() -} + // An AWS Key Management Service (KMS) key and an AWS Identity and Access Management + // (IAM) role that Amazon Forecast can assume to access the key. You can specify + // this optional object in the CreateDataset and CreatePredictor requests. + EncryptionConfig *EncryptionConfig `type:"structure"` -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *CreateDatasetGroupOutput) SetDatasetGroupArn(v string) *CreateDatasetGroupOutput { - s.DatasetGroupArn = &v - return s -} + ExplainPredictor *bool `type:"boolean"` -type CreateDatasetImportJobInput struct { - _ struct{} `type:"structure"` + // An array of dimension (field) names that specify how to group the generated + // forecast. + // + // For example, if you are generating forecasts for item sales across all your + // stores, and your dataset contains a store_id field, you would specify store_id + // as a dimension to group sales forecasts for each store. + ForecastDimensions []*string `min:"1" type:"list"` - // The location of the training data to import and an AWS Identity and Access - // Management (IAM) role that Amazon Forecast can assume to access the data. - // The training data must be stored in an Amazon S3 bucket. + // The frequency of predictions in a forecast. // - // If encryption is used, DataSource must include an AWS Key Management Service - // (KMS) key and the IAM role must allow Amazon Forecast permission to access - // the key. The KMS key and IAM role must match those specified in the EncryptionConfig - // parameter of the CreateDataset operation. + // Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min + // (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and + // 1min (1 minute). For example, "Y" indicates every year and "5min" indicates + // every five minutes. // - // DataSource is a required field - DataSource *DataSource `type:"structure" required:"true"` - - // The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want - // to import data to. + // The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset + // frequency. // - // DatasetArn is a required field - DatasetArn *string `type:"string" required:"true"` + // When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal + // to the RELATED_TIME_SERIES dataset frequency. + ForecastFrequency *string `min:"1" type:"string"` - // The name for the dataset import job. We recommend including the current timestamp - // in the name, for example, 20190721DatasetImport. This can help you avoid - // getting a ResourceAlreadyExistsException exception. - // - // DatasetImportJobName is a required field - DatasetImportJobName *string `min:"1" type:"string" required:"true"` + // The number of time-steps that the model predicts. The forecast horizon is + // also called the prediction length. + ForecastHorizon *int64 `type:"integer"` - // The format of the geolocation attribute. The geolocation attribute can be - // formatted in one of two ways: - // - // * LAT_LONG - the latitude and longitude in decimal format (Example: 47.61_-122.33). + // The forecast types used to train a predictor. You can specify up to five + // forecast types. Forecast types can be quantiles from 0.01 to 0.99, by increments + // of 0.01 or higher. You can also specify the mean forecast with mean. + ForecastTypes []*string `min:"1" type:"list"` + + // The accuracy metric used to optimize the predictor. + OptimizationMetric *string `type:"string" enum:"OptimizationMetric"` + + // A unique name for the predictor // - // * CC_POSTALCODE (US Only) - the country code (US), followed by the 5-digit - // ZIP code (Example: US_98121). - GeolocationFormat *string `type:"string"` + // PredictorName is a required field + PredictorName *string `min:"1" type:"string" required:"true"` - // The optional metadata that you apply to the dataset import job to help you - // categorize and organize them. Each tag consists of a key and an optional - // value, both of which you define. + // The ARN of the predictor to retrain or upgrade. This parameter is only used + // when retraining or upgrading a predictor. When creating a new predictor, + // do not specify a value for this parameter. // - // The following basic restrictions apply to tags: + // When upgrading or retraining a predictor, only specify values for the ReferencePredictorArn + // and PredictorName. The value for PredictorName must be a unique predictor + // name. + ReferencePredictorArn *string `type:"string"` + + // Optional metadata to help you categorize and organize your predictors. Each + // tag consists of a key and an optional value, both of which you define. Tag + // keys and values are case sensitive. // - // * Maximum number of tags per resource - 50. + // The following restrictions apply to tags: // - // * For each resource, each tag key must be unique, and each tag key can - // have only one value. + // * For each resource, each tag key must be unique and each tag key must + // have one value. // - // * Maximum key length - 128 Unicode characters in UTF-8. + // * Maximum number of tags per resource: 50. // - // * Maximum value length - 256 Unicode characters in UTF-8. + // * Maximum key length: 128 Unicode characters in UTF-8. // - // * If your tagging schema is used across multiple services and resources, - // remember that other services may have restrictions on allowed characters. - // Generally allowed characters are: letters, numbers, and spaces representable - // in UTF-8, and the following characters: + - = . _ : / @. + // * Maximum value length: 256 Unicode characters in UTF-8. // - // * Tag keys and values are case sensitive. + // * Accepted characters: all letters and numbers, spaces representable in + // UTF-8, and + - = . _ : / @. If your tagging schema is used across other + // services and resources, the character restrictions of those services also + // apply. // - // * Do not use aws:, AWS:, or any upper or lowercase combination of such - // as a prefix for keys as it is reserved for AWS use. You cannot edit or - // delete tag keys with this prefix. Values can have this prefix. If a tag - // value has aws as its prefix but the key does not, then Forecast considers - // it to be a user tag and will count against the limit of 50 tags. Tags - // with only the key prefix of aws do not count against your tags per resource - // limit. + // * Key prefixes cannot include any upper or lowercase combination of aws: + // or AWS:. Values can have this prefix. If a tag value has aws as its prefix + // but the key does not, Forecast considers it to be a user tag and will + // count against the limit of 50 tags. Tags with only the key prefix of aws + // do not count against your tags per resource limit. You cannot edit or + // delete tag keys with this prefix. Tags []*Tag `type:"list"` - - // A single time zone for every item in your dataset. This option is ideal for - // datasets with all timestamps within a single time zone, or if all timestamps - // are normalized to a single time zone. - // - // Refer to the Joda-Time API (http://joda-time.sourceforge.net/timezones.html) - // for a complete list of valid time zone names. - TimeZone *string `type:"string"` - - // The format of timestamps in the dataset. The format that you specify depends - // on the DataFrequency specified when the dataset was created. The following - // formats are supported - // - // * "yyyy-MM-dd" For the following data frequencies: Y, M, W, and D - // - // * "yyyy-MM-dd HH:mm:ss" For the following data frequencies: H, 30min, - // 15min, and 1min; and optionally, for: Y, M, W, and D - // - // If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd - // HH:mm:ss". - TimestampFormat *string `type:"string"` - - // Automatically derive time zone information from the geolocation attribute. - // This option is ideal for datasets that contain timestamps in multiple time - // zones and those timestamps are expressed in local time. - UseGeolocationForTimeZone *bool `type:"boolean"` } // String returns the string representation. @@ -4250,7 +5421,7 @@ type CreateDatasetImportJobInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateDatasetImportJobInput) String() string { +func (s CreateAutoPredictorInput) String() string { return awsutil.Prettify(s) } @@ -4259,28 +5430,36 @@ func (s CreateDatasetImportJobInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateDatasetImportJobInput) GoString() string { +func (s CreateAutoPredictorInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateDatasetImportJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateDatasetImportJobInput"} - if s.DataSource == nil { - invalidParams.Add(request.NewErrParamRequired("DataSource")) +func (s *CreateAutoPredictorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateAutoPredictorInput"} + if s.ForecastDimensions != nil && len(s.ForecastDimensions) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ForecastDimensions", 1)) } - if s.DatasetArn == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetArn")) + if s.ForecastFrequency != nil && len(*s.ForecastFrequency) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ForecastFrequency", 1)) } - if s.DatasetImportJobName == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetImportJobName")) + if s.ForecastTypes != nil && len(s.ForecastTypes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ForecastTypes", 1)) } - if s.DatasetImportJobName != nil && len(*s.DatasetImportJobName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatasetImportJobName", 1)) + if s.PredictorName == nil { + invalidParams.Add(request.NewErrParamRequired("PredictorName")) } - if s.DataSource != nil { - if err := s.DataSource.Validate(); err != nil { - invalidParams.AddNested("DataSource", err.(request.ErrInvalidParams)) + if s.PredictorName != nil && len(*s.PredictorName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PredictorName", 1)) + } + if s.DataConfig != nil { + if err := s.DataConfig.Validate(); err != nil { + invalidParams.AddNested("DataConfig", err.(request.ErrInvalidParams)) + } + } + if s.EncryptionConfig != nil { + if err := s.EncryptionConfig.Validate(); err != nil { + invalidParams.AddNested("EncryptionConfig", err.(request.ErrInvalidParams)) } } if s.Tags != nil { @@ -4300,59 +5479,77 @@ func (s *CreateDatasetImportJobInput) Validate() error { return nil } -// SetDataSource sets the DataSource field's value. -func (s *CreateDatasetImportJobInput) SetDataSource(v *DataSource) *CreateDatasetImportJobInput { - s.DataSource = v +// SetDataConfig sets the DataConfig field's value. +func (s *CreateAutoPredictorInput) SetDataConfig(v *DataConfig) *CreateAutoPredictorInput { + s.DataConfig = v return s } -// SetDatasetArn sets the DatasetArn field's value. -func (s *CreateDatasetImportJobInput) SetDatasetArn(v string) *CreateDatasetImportJobInput { - s.DatasetArn = &v +// SetEncryptionConfig sets the EncryptionConfig field's value. +func (s *CreateAutoPredictorInput) SetEncryptionConfig(v *EncryptionConfig) *CreateAutoPredictorInput { + s.EncryptionConfig = v return s } -// SetDatasetImportJobName sets the DatasetImportJobName field's value. -func (s *CreateDatasetImportJobInput) SetDatasetImportJobName(v string) *CreateDatasetImportJobInput { - s.DatasetImportJobName = &v +// SetExplainPredictor sets the ExplainPredictor field's value. +func (s *CreateAutoPredictorInput) SetExplainPredictor(v bool) *CreateAutoPredictorInput { + s.ExplainPredictor = &v return s } -// SetGeolocationFormat sets the GeolocationFormat field's value. -func (s *CreateDatasetImportJobInput) SetGeolocationFormat(v string) *CreateDatasetImportJobInput { - s.GeolocationFormat = &v +// SetForecastDimensions sets the ForecastDimensions field's value. +func (s *CreateAutoPredictorInput) SetForecastDimensions(v []*string) *CreateAutoPredictorInput { + s.ForecastDimensions = v return s } -// SetTags sets the Tags field's value. -func (s *CreateDatasetImportJobInput) SetTags(v []*Tag) *CreateDatasetImportJobInput { - s.Tags = v +// SetForecastFrequency sets the ForecastFrequency field's value. +func (s *CreateAutoPredictorInput) SetForecastFrequency(v string) *CreateAutoPredictorInput { + s.ForecastFrequency = &v return s } -// SetTimeZone sets the TimeZone field's value. -func (s *CreateDatasetImportJobInput) SetTimeZone(v string) *CreateDatasetImportJobInput { - s.TimeZone = &v +// SetForecastHorizon sets the ForecastHorizon field's value. +func (s *CreateAutoPredictorInput) SetForecastHorizon(v int64) *CreateAutoPredictorInput { + s.ForecastHorizon = &v return s } -// SetTimestampFormat sets the TimestampFormat field's value. -func (s *CreateDatasetImportJobInput) SetTimestampFormat(v string) *CreateDatasetImportJobInput { - s.TimestampFormat = &v +// SetForecastTypes sets the ForecastTypes field's value. +func (s *CreateAutoPredictorInput) SetForecastTypes(v []*string) *CreateAutoPredictorInput { + s.ForecastTypes = v return s } -// SetUseGeolocationForTimeZone sets the UseGeolocationForTimeZone field's value. -func (s *CreateDatasetImportJobInput) SetUseGeolocationForTimeZone(v bool) *CreateDatasetImportJobInput { - s.UseGeolocationForTimeZone = &v +// SetOptimizationMetric sets the OptimizationMetric field's value. +func (s *CreateAutoPredictorInput) SetOptimizationMetric(v string) *CreateAutoPredictorInput { + s.OptimizationMetric = &v return s } -type CreateDatasetImportJobOutput struct { +// SetPredictorName sets the PredictorName field's value. +func (s *CreateAutoPredictorInput) SetPredictorName(v string) *CreateAutoPredictorInput { + s.PredictorName = &v + return s +} + +// SetReferencePredictorArn sets the ReferencePredictorArn field's value. +func (s *CreateAutoPredictorInput) SetReferencePredictorArn(v string) *CreateAutoPredictorInput { + s.ReferencePredictorArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateAutoPredictorInput) SetTags(v []*Tag) *CreateAutoPredictorInput { + s.Tags = v + return s +} + +type CreateAutoPredictorOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset import job. - DatasetImportJobArn *string `type:"string"` + // The Amazon Resource Name (ARN) of the predictor. + PredictorArn *string `type:"string"` } // String returns the string representation. @@ -4360,7 +5557,7 @@ type CreateDatasetImportJobOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateDatasetImportJobOutput) String() string { +func (s CreateAutoPredictorOutput) String() string { return awsutil.Prettify(s) } @@ -4369,64 +5566,42 @@ func (s CreateDatasetImportJobOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateDatasetImportJobOutput) GoString() string { +func (s CreateAutoPredictorOutput) GoString() string { return s.String() } -// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. -func (s *CreateDatasetImportJobOutput) SetDatasetImportJobArn(v string) *CreateDatasetImportJobOutput { - s.DatasetImportJobArn = &v +// SetPredictorArn sets the PredictorArn field's value. +func (s *CreateAutoPredictorOutput) SetPredictorArn(v string) *CreateAutoPredictorOutput { + s.PredictorArn = &v return s } -type CreateDatasetInput struct { +type CreateDatasetGroupInput struct { _ struct{} `type:"structure"` - // The frequency of data collection. This parameter is required for RELATED_TIME_SERIES - // datasets. - // - // Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min - // (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and - // 1min (1 minute). For example, "D" indicates every day and "15min" indicates - // every 15 minutes. - DataFrequency *string `type:"string"` - - // A name for the dataset. - // - // DatasetName is a required field - DatasetName *string `min:"1" type:"string" required:"true"` + // An array of Amazon Resource Names (ARNs) of the datasets that you want to + // include in the dataset group. + DatasetArns []*string `type:"list"` - // The dataset type. Valid values depend on the chosen Domain. + // A name for the dataset group. // - // DatasetType is a required field - DatasetType *string `type:"string" required:"true" enum:"DatasetType"` + // DatasetGroupName is a required field + DatasetGroupName *string `min:"1" type:"string" required:"true"` - // The domain associated with the dataset. When you add a dataset to a dataset - // group, this value and the value specified for the Domain parameter of the - // CreateDatasetGroup operation must match. + // The domain associated with the dataset group. When you add a dataset to a + // dataset group, this value and the value specified for the Domain parameter + // of the CreateDataset operation must match. // // The Domain and DatasetType that you choose determine the fields that must - // be present in the training data that you import to the dataset. For example, - // if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, - // Amazon Forecast requires item_id, timestamp, and demand fields to be present + // be present in training data that you import to a dataset. For example, if + // you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, Amazon + // Forecast requires that item_id, timestamp, and demand fields are present // in your data. For more information, see howitworks-datasets-groups. // // Domain is a required field Domain *string `type:"string" required:"true" enum:"Domain"` - // An AWS Key Management Service (KMS) key and the AWS Identity and Access Management - // (IAM) role that Amazon Forecast can assume to access the key. - EncryptionConfig *EncryptionConfig `type:"structure"` - - // The schema for the dataset. The schema attributes and their order must match - // the fields in your data. The dataset Domain and DatasetType that you choose - // determine the minimum required fields in your training data. For information - // about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types. - // - // Schema is a required field - Schema *Schema `type:"structure" required:"true"` - - // The optional metadata that you apply to the dataset to help you categorize + // The optional metadata that you apply to the dataset group to help you categorize // and organize them. Each tag consists of a key and an optional value, both // of which you define. // @@ -4463,7 +5638,7 @@ type CreateDatasetInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateDatasetInput) String() string { +func (s CreateDatasetGroupInput) String() string { return awsutil.Prettify(s) } @@ -4472,38 +5647,22 @@ func (s CreateDatasetInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateDatasetInput) GoString() string { +func (s CreateDatasetGroupInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateDatasetInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateDatasetInput"} - if s.DatasetName == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetName")) - } - if s.DatasetName != nil && len(*s.DatasetName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("DatasetName", 1)) +func (s *CreateDatasetGroupInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateDatasetGroupInput"} + if s.DatasetGroupName == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetGroupName")) } - if s.DatasetType == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetType")) + if s.DatasetGroupName != nil && len(*s.DatasetGroupName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetGroupName", 1)) } if s.Domain == nil { invalidParams.Add(request.NewErrParamRequired("Domain")) } - if s.Schema == nil { - invalidParams.Add(request.NewErrParamRequired("Schema")) - } - if s.EncryptionConfig != nil { - if err := s.EncryptionConfig.Validate(); err != nil { - invalidParams.AddNested("EncryptionConfig", err.(request.ErrInvalidParams)) - } - } - if s.Schema != nil { - if err := s.Schema.Validate(); err != nil { - invalidParams.AddNested("Schema", err.(request.ErrInvalidParams)) - } - } if s.Tags != nil { for i, v := range s.Tags { if v == nil { @@ -4521,53 +5680,35 @@ func (s *CreateDatasetInput) Validate() error { return nil } -// SetDataFrequency sets the DataFrequency field's value. -func (s *CreateDatasetInput) SetDataFrequency(v string) *CreateDatasetInput { - s.DataFrequency = &v - return s -} - -// SetDatasetName sets the DatasetName field's value. -func (s *CreateDatasetInput) SetDatasetName(v string) *CreateDatasetInput { - s.DatasetName = &v +// SetDatasetArns sets the DatasetArns field's value. +func (s *CreateDatasetGroupInput) SetDatasetArns(v []*string) *CreateDatasetGroupInput { + s.DatasetArns = v return s } -// SetDatasetType sets the DatasetType field's value. -func (s *CreateDatasetInput) SetDatasetType(v string) *CreateDatasetInput { - s.DatasetType = &v +// SetDatasetGroupName sets the DatasetGroupName field's value. +func (s *CreateDatasetGroupInput) SetDatasetGroupName(v string) *CreateDatasetGroupInput { + s.DatasetGroupName = &v return s } // SetDomain sets the Domain field's value. -func (s *CreateDatasetInput) SetDomain(v string) *CreateDatasetInput { +func (s *CreateDatasetGroupInput) SetDomain(v string) *CreateDatasetGroupInput { s.Domain = &v return s } -// SetEncryptionConfig sets the EncryptionConfig field's value. -func (s *CreateDatasetInput) SetEncryptionConfig(v *EncryptionConfig) *CreateDatasetInput { - s.EncryptionConfig = v - return s -} - -// SetSchema sets the Schema field's value. -func (s *CreateDatasetInput) SetSchema(v *Schema) *CreateDatasetInput { - s.Schema = v - return s -} - // SetTags sets the Tags field's value. -func (s *CreateDatasetInput) SetTags(v []*Tag) *CreateDatasetInput { +func (s *CreateDatasetGroupInput) SetTags(v []*Tag) *CreateDatasetGroupInput { s.Tags = v return s } -type CreateDatasetOutput struct { +type CreateDatasetGroupOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset. - DatasetArn *string `type:"string"` + // The Amazon Resource Name (ARN) of the dataset group. + DatasetGroupArn *string `type:"string"` } // String returns the string representation. @@ -4575,7 +5716,7 @@ type CreateDatasetOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateDatasetOutput) String() string { +func (s CreateDatasetGroupOutput) String() string { return awsutil.Prettify(s) } @@ -4584,41 +5725,54 @@ func (s CreateDatasetOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateDatasetOutput) GoString() string { +func (s CreateDatasetGroupOutput) GoString() string { return s.String() } -// SetDatasetArn sets the DatasetArn field's value. -func (s *CreateDatasetOutput) SetDatasetArn(v string) *CreateDatasetOutput { - s.DatasetArn = &v +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *CreateDatasetGroupOutput) SetDatasetGroupArn(v string) *CreateDatasetGroupOutput { + s.DatasetGroupArn = &v return s } -type CreateForecastExportJobInput struct { +type CreateDatasetImportJobInput struct { _ struct{} `type:"structure"` - // The location where you want to save the forecast and an AWS Identity and - // Access Management (IAM) role that Amazon Forecast can assume to access the - // location. The forecast must be exported to an Amazon S3 bucket. + // The location of the training data to import and an AWS Identity and Access + // Management (IAM) role that Amazon Forecast can assume to access the data. + // The training data must be stored in an Amazon S3 bucket. // - // If encryption is used, Destination must include an AWS Key Management Service - // (KMS) key. The IAM role must allow Amazon Forecast permission to access the - // key. + // If encryption is used, DataSource must include an AWS Key Management Service + // (KMS) key and the IAM role must allow Amazon Forecast permission to access + // the key. The KMS key and IAM role must match those specified in the EncryptionConfig + // parameter of the CreateDataset operation. // - // Destination is a required field - Destination *DataDestination `type:"structure" required:"true"` + // DataSource is a required field + DataSource *DataSource `type:"structure" required:"true"` - // The Amazon Resource Name (ARN) of the forecast that you want to export. + // The Amazon Resource Name (ARN) of the Amazon Forecast dataset that you want + // to import data to. // - // ForecastArn is a required field - ForecastArn *string `type:"string" required:"true"` + // DatasetArn is a required field + DatasetArn *string `type:"string" required:"true"` - // The name for the forecast export job. + // The name for the dataset import job. We recommend including the current timestamp + // in the name, for example, 20190721DatasetImport. This can help you avoid + // getting a ResourceAlreadyExistsException exception. // - // ForecastExportJobName is a required field - ForecastExportJobName *string `min:"1" type:"string" required:"true"` + // DatasetImportJobName is a required field + DatasetImportJobName *string `min:"1" type:"string" required:"true"` - // The optional metadata that you apply to the forecast export job to help you + // The format of the geolocation attribute. The geolocation attribute can be + // formatted in one of two ways: + // + // * LAT_LONG - the latitude and longitude in decimal format (Example: 47.61_-122.33). + // + // * CC_POSTALCODE (US Only) - the country code (US), followed by the 5-digit + // ZIP code (Example: US_98121). + GeolocationFormat *string `type:"string"` + + // The optional metadata that you apply to the dataset import job to help you // categorize and organize them. Each tag consists of a key and an optional // value, both of which you define. // @@ -4648,6 +5802,32 @@ type CreateForecastExportJobInput struct { // with only the key prefix of aws do not count against your tags per resource // limit. Tags []*Tag `type:"list"` + + // A single time zone for every item in your dataset. This option is ideal for + // datasets with all timestamps within a single time zone, or if all timestamps + // are normalized to a single time zone. + // + // Refer to the Joda-Time API (http://joda-time.sourceforge.net/timezones.html) + // for a complete list of valid time zone names. + TimeZone *string `type:"string"` + + // The format of timestamps in the dataset. The format that you specify depends + // on the DataFrequency specified when the dataset was created. The following + // formats are supported + // + // * "yyyy-MM-dd" For the following data frequencies: Y, M, W, and D + // + // * "yyyy-MM-dd HH:mm:ss" For the following data frequencies: H, 30min, + // 15min, and 1min; and optionally, for: Y, M, W, and D + // + // If the format isn't specified, Amazon Forecast expects the format to be "yyyy-MM-dd + // HH:mm:ss". + TimestampFormat *string `type:"string"` + + // Automatically derive time zone information from the geolocation attribute. + // This option is ideal for datasets that contain timestamps in multiple time + // zones and those timestamps are expressed in local time. + UseGeolocationForTimeZone *bool `type:"boolean"` } // String returns the string representation. @@ -4655,7 +5835,7 @@ type CreateForecastExportJobInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateForecastExportJobInput) String() string { +func (s CreateDatasetImportJobInput) String() string { return awsutil.Prettify(s) } @@ -4664,28 +5844,28 @@ func (s CreateForecastExportJobInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateForecastExportJobInput) GoString() string { +func (s CreateDatasetImportJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateForecastExportJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateForecastExportJobInput"} - if s.Destination == nil { - invalidParams.Add(request.NewErrParamRequired("Destination")) +func (s *CreateDatasetImportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateDatasetImportJobInput"} + if s.DataSource == nil { + invalidParams.Add(request.NewErrParamRequired("DataSource")) } - if s.ForecastArn == nil { - invalidParams.Add(request.NewErrParamRequired("ForecastArn")) + if s.DatasetArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetArn")) } - if s.ForecastExportJobName == nil { - invalidParams.Add(request.NewErrParamRequired("ForecastExportJobName")) + if s.DatasetImportJobName == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetImportJobName")) } - if s.ForecastExportJobName != nil && len(*s.ForecastExportJobName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ForecastExportJobName", 1)) + if s.DatasetImportJobName != nil && len(*s.DatasetImportJobName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetImportJobName", 1)) } - if s.Destination != nil { - if err := s.Destination.Validate(); err != nil { - invalidParams.AddNested("Destination", err.(request.ErrInvalidParams)) + if s.DataSource != nil { + if err := s.DataSource.Validate(); err != nil { + invalidParams.AddNested("DataSource", err.(request.ErrInvalidParams)) } } if s.Tags != nil { @@ -4705,35 +5885,59 @@ func (s *CreateForecastExportJobInput) Validate() error { return nil } -// SetDestination sets the Destination field's value. -func (s *CreateForecastExportJobInput) SetDestination(v *DataDestination) *CreateForecastExportJobInput { - s.Destination = v +// SetDataSource sets the DataSource field's value. +func (s *CreateDatasetImportJobInput) SetDataSource(v *DataSource) *CreateDatasetImportJobInput { + s.DataSource = v return s } -// SetForecastArn sets the ForecastArn field's value. -func (s *CreateForecastExportJobInput) SetForecastArn(v string) *CreateForecastExportJobInput { - s.ForecastArn = &v +// SetDatasetArn sets the DatasetArn field's value. +func (s *CreateDatasetImportJobInput) SetDatasetArn(v string) *CreateDatasetImportJobInput { + s.DatasetArn = &v return s } -// SetForecastExportJobName sets the ForecastExportJobName field's value. -func (s *CreateForecastExportJobInput) SetForecastExportJobName(v string) *CreateForecastExportJobInput { - s.ForecastExportJobName = &v +// SetDatasetImportJobName sets the DatasetImportJobName field's value. +func (s *CreateDatasetImportJobInput) SetDatasetImportJobName(v string) *CreateDatasetImportJobInput { + s.DatasetImportJobName = &v + return s +} + +// SetGeolocationFormat sets the GeolocationFormat field's value. +func (s *CreateDatasetImportJobInput) SetGeolocationFormat(v string) *CreateDatasetImportJobInput { + s.GeolocationFormat = &v return s } // SetTags sets the Tags field's value. -func (s *CreateForecastExportJobInput) SetTags(v []*Tag) *CreateForecastExportJobInput { +func (s *CreateDatasetImportJobInput) SetTags(v []*Tag) *CreateDatasetImportJobInput { s.Tags = v return s } -type CreateForecastExportJobOutput struct { +// SetTimeZone sets the TimeZone field's value. +func (s *CreateDatasetImportJobInput) SetTimeZone(v string) *CreateDatasetImportJobInput { + s.TimeZone = &v + return s +} + +// SetTimestampFormat sets the TimestampFormat field's value. +func (s *CreateDatasetImportJobInput) SetTimestampFormat(v string) *CreateDatasetImportJobInput { + s.TimestampFormat = &v + return s +} + +// SetUseGeolocationForTimeZone sets the UseGeolocationForTimeZone field's value. +func (s *CreateDatasetImportJobInput) SetUseGeolocationForTimeZone(v bool) *CreateDatasetImportJobInput { + s.UseGeolocationForTimeZone = &v + return s +} + +type CreateDatasetImportJobOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the export job. - ForecastExportJobArn *string `type:"string"` + // The Amazon Resource Name (ARN) of the dataset import job. + DatasetImportJobArn *string `type:"string"` } // String returns the string representation. @@ -4741,7 +5945,7 @@ type CreateForecastExportJobOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateForecastExportJobOutput) String() string { +func (s CreateDatasetImportJobOutput) String() string { return awsutil.Prettify(s) } @@ -4750,48 +5954,75 @@ func (s CreateForecastExportJobOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateForecastExportJobOutput) GoString() string { +func (s CreateDatasetImportJobOutput) GoString() string { return s.String() } -// SetForecastExportJobArn sets the ForecastExportJobArn field's value. -func (s *CreateForecastExportJobOutput) SetForecastExportJobArn(v string) *CreateForecastExportJobOutput { - s.ForecastExportJobArn = &v +// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. +func (s *CreateDatasetImportJobOutput) SetDatasetImportJobArn(v string) *CreateDatasetImportJobOutput { + s.DatasetImportJobArn = &v return s } -type CreateForecastInput struct { +type CreateDatasetInput struct { _ struct{} `type:"structure"` - // A name for the forecast. + // The frequency of data collection. This parameter is required for RELATED_TIME_SERIES + // datasets. // - // ForecastName is a required field - ForecastName *string `min:"1" type:"string" required:"true"` - - // The quantiles at which probabilistic forecasts are generated. You can currently - // specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99 - // (increments of .01 only) and mean. The mean forecast is different from the - // median (0.50) when the distribution is not symmetric (for example, Beta and - // Negative Binomial). The default value is ["0.1", "0.5", "0.9"]. - ForecastTypes []*string `min:"1" type:"list"` + // Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min + // (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and + // 1min (1 minute). For example, "D" indicates every day and "15min" indicates + // every 15 minutes. + DataFrequency *string `min:"1" type:"string"` - // The Amazon Resource Name (ARN) of the predictor to use to generate the forecast. + // A name for the dataset. // - // PredictorArn is a required field - PredictorArn *string `type:"string" required:"true"` + // DatasetName is a required field + DatasetName *string `min:"1" type:"string" required:"true"` - // The optional metadata that you apply to the forecast to help you categorize - // and organize them. Each tag consists of a key and an optional value, both - // of which you define. - // - // The following basic restrictions apply to tags: + // The dataset type. Valid values depend on the chosen Domain. // - // * Maximum number of tags per resource - 50. + // DatasetType is a required field + DatasetType *string `type:"string" required:"true" enum:"DatasetType"` + + // The domain associated with the dataset. When you add a dataset to a dataset + // group, this value and the value specified for the Domain parameter of the + // CreateDatasetGroup operation must match. // - // * For each resource, each tag key must be unique, and each tag key can - // have only one value. + // The Domain and DatasetType that you choose determine the fields that must + // be present in the training data that you import to the dataset. For example, + // if you choose the RETAIL domain and TARGET_TIME_SERIES as the DatasetType, + // Amazon Forecast requires item_id, timestamp, and demand fields to be present + // in your data. For more information, see howitworks-datasets-groups. // - // * Maximum key length - 128 Unicode characters in UTF-8. + // Domain is a required field + Domain *string `type:"string" required:"true" enum:"Domain"` + + // An AWS Key Management Service (KMS) key and the AWS Identity and Access Management + // (IAM) role that Amazon Forecast can assume to access the key. + EncryptionConfig *EncryptionConfig `type:"structure"` + + // The schema for the dataset. The schema attributes and their order must match + // the fields in your data. The dataset Domain and DatasetType that you choose + // determine the minimum required fields in your training data. For information + // about the required fields for a specific dataset domain and type, see howitworks-domains-ds-types. + // + // Schema is a required field + Schema *Schema `type:"structure" required:"true"` + + // The optional metadata that you apply to the dataset to help you categorize + // and organize them. Each tag consists of a key and an optional value, both + // of which you define. + // + // The following basic restrictions apply to tags: + // + // * Maximum number of tags per resource - 50. + // + // * For each resource, each tag key must be unique, and each tag key can + // have only one value. + // + // * Maximum key length - 128 Unicode characters in UTF-8. // // * Maximum value length - 256 Unicode characters in UTF-8. // @@ -4817,7 +6048,7 @@ type CreateForecastInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateForecastInput) String() string { +func (s CreateDatasetInput) String() string { return awsutil.Prettify(s) } @@ -4826,24 +6057,40 @@ func (s CreateForecastInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateForecastInput) GoString() string { +func (s CreateDatasetInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreateForecastInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreateForecastInput"} - if s.ForecastName == nil { - invalidParams.Add(request.NewErrParamRequired("ForecastName")) +func (s *CreateDatasetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateDatasetInput"} + if s.DataFrequency != nil && len(*s.DataFrequency) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DataFrequency", 1)) } - if s.ForecastName != nil && len(*s.ForecastName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ForecastName", 1)) + if s.DatasetName == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetName")) } - if s.ForecastTypes != nil && len(s.ForecastTypes) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ForecastTypes", 1)) + if s.DatasetName != nil && len(*s.DatasetName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("DatasetName", 1)) } - if s.PredictorArn == nil { - invalidParams.Add(request.NewErrParamRequired("PredictorArn")) + if s.DatasetType == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetType")) + } + if s.Domain == nil { + invalidParams.Add(request.NewErrParamRequired("Domain")) + } + if s.Schema == nil { + invalidParams.Add(request.NewErrParamRequired("Schema")) + } + if s.EncryptionConfig != nil { + if err := s.EncryptionConfig.Validate(); err != nil { + invalidParams.AddNested("EncryptionConfig", err.(request.ErrInvalidParams)) + } + } + if s.Schema != nil { + if err := s.Schema.Validate(); err != nil { + invalidParams.AddNested("Schema", err.(request.ErrInvalidParams)) + } } if s.Tags != nil { for i, v := range s.Tags { @@ -4862,35 +6109,53 @@ func (s *CreateForecastInput) Validate() error { return nil } -// SetForecastName sets the ForecastName field's value. -func (s *CreateForecastInput) SetForecastName(v string) *CreateForecastInput { - s.ForecastName = &v +// SetDataFrequency sets the DataFrequency field's value. +func (s *CreateDatasetInput) SetDataFrequency(v string) *CreateDatasetInput { + s.DataFrequency = &v return s } -// SetForecastTypes sets the ForecastTypes field's value. -func (s *CreateForecastInput) SetForecastTypes(v []*string) *CreateForecastInput { - s.ForecastTypes = v +// SetDatasetName sets the DatasetName field's value. +func (s *CreateDatasetInput) SetDatasetName(v string) *CreateDatasetInput { + s.DatasetName = &v return s } -// SetPredictorArn sets the PredictorArn field's value. -func (s *CreateForecastInput) SetPredictorArn(v string) *CreateForecastInput { - s.PredictorArn = &v +// SetDatasetType sets the DatasetType field's value. +func (s *CreateDatasetInput) SetDatasetType(v string) *CreateDatasetInput { + s.DatasetType = &v + return s +} + +// SetDomain sets the Domain field's value. +func (s *CreateDatasetInput) SetDomain(v string) *CreateDatasetInput { + s.Domain = &v + return s +} + +// SetEncryptionConfig sets the EncryptionConfig field's value. +func (s *CreateDatasetInput) SetEncryptionConfig(v *EncryptionConfig) *CreateDatasetInput { + s.EncryptionConfig = v + return s +} + +// SetSchema sets the Schema field's value. +func (s *CreateDatasetInput) SetSchema(v *Schema) *CreateDatasetInput { + s.Schema = v return s } // SetTags sets the Tags field's value. -func (s *CreateForecastInput) SetTags(v []*Tag) *CreateForecastInput { +func (s *CreateDatasetInput) SetTags(v []*Tag) *CreateDatasetInput { s.Tags = v return s } -type CreateForecastOutput struct { +type CreateDatasetOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the forecast. - ForecastArn *string `type:"string"` + // The Amazon Resource Name (ARN) of the dataset. + DatasetArn *string `type:"string"` } // String returns the string representation. @@ -4898,7 +6163,7 @@ type CreateForecastOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateForecastOutput) String() string { +func (s CreateDatasetOutput) String() string { return awsutil.Prettify(s) } @@ -4907,17 +6172,17 @@ func (s CreateForecastOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreateForecastOutput) GoString() string { +func (s CreateDatasetOutput) GoString() string { return s.String() } -// SetForecastArn sets the ForecastArn field's value. -func (s *CreateForecastOutput) SetForecastArn(v string) *CreateForecastOutput { - s.ForecastArn = &v +// SetDatasetArn sets the DatasetArn field's value. +func (s *CreateDatasetOutput) SetDatasetArn(v string) *CreateDatasetOutput { + s.DatasetArn = &v return s } -type CreatePredictorBacktestExportJobInput struct { +type CreateExplainabilityExportInput struct { _ struct{} `type:"structure"` // The destination for an export job. Provide an S3 path, an AWS Identity and @@ -4927,17 +6192,17 @@ type CreatePredictorBacktestExportJobInput struct { // Destination is a required field Destination *DataDestination `type:"structure" required:"true"` - // The Amazon Resource Name (ARN) of the predictor that you want to export. + // The Amazon Resource Name (ARN) of the Explainability to export. // - // PredictorArn is a required field - PredictorArn *string `type:"string" required:"true"` + // ExplainabilityArn is a required field + ExplainabilityArn *string `type:"string" required:"true"` - // The name for the backtest export job. + // A unique name for the Explainability export. // - // PredictorBacktestExportJobName is a required field - PredictorBacktestExportJobName *string `min:"1" type:"string" required:"true"` + // ExplainabilityExportName is a required field + ExplainabilityExportName *string `min:"1" type:"string" required:"true"` - // Optional metadata to help you categorize and organize your backtests. Each + // Optional metadata to help you categorize and organize your resources. Each // tag consists of a key and an optional value, both of which you define. Tag // keys and values are case sensitive. // @@ -4971,7 +6236,7 @@ type CreatePredictorBacktestExportJobInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreatePredictorBacktestExportJobInput) String() string { +func (s CreateExplainabilityExportInput) String() string { return awsutil.Prettify(s) } @@ -4980,24 +6245,24 @@ func (s CreatePredictorBacktestExportJobInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreatePredictorBacktestExportJobInput) GoString() string { +func (s CreateExplainabilityExportInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *CreatePredictorBacktestExportJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreatePredictorBacktestExportJobInput"} +func (s *CreateExplainabilityExportInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateExplainabilityExportInput"} if s.Destination == nil { invalidParams.Add(request.NewErrParamRequired("Destination")) } - if s.PredictorArn == nil { - invalidParams.Add(request.NewErrParamRequired("PredictorArn")) + if s.ExplainabilityArn == nil { + invalidParams.Add(request.NewErrParamRequired("ExplainabilityArn")) } - if s.PredictorBacktestExportJobName == nil { - invalidParams.Add(request.NewErrParamRequired("PredictorBacktestExportJobName")) + if s.ExplainabilityExportName == nil { + invalidParams.Add(request.NewErrParamRequired("ExplainabilityExportName")) } - if s.PredictorBacktestExportJobName != nil && len(*s.PredictorBacktestExportJobName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("PredictorBacktestExportJobName", 1)) + if s.ExplainabilityExportName != nil && len(*s.ExplainabilityExportName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ExplainabilityExportName", 1)) } if s.Destination != nil { if err := s.Destination.Validate(); err != nil { @@ -5022,35 +6287,34 @@ func (s *CreatePredictorBacktestExportJobInput) Validate() error { } // SetDestination sets the Destination field's value. -func (s *CreatePredictorBacktestExportJobInput) SetDestination(v *DataDestination) *CreatePredictorBacktestExportJobInput { +func (s *CreateExplainabilityExportInput) SetDestination(v *DataDestination) *CreateExplainabilityExportInput { s.Destination = v return s } -// SetPredictorArn sets the PredictorArn field's value. -func (s *CreatePredictorBacktestExportJobInput) SetPredictorArn(v string) *CreatePredictorBacktestExportJobInput { - s.PredictorArn = &v +// SetExplainabilityArn sets the ExplainabilityArn field's value. +func (s *CreateExplainabilityExportInput) SetExplainabilityArn(v string) *CreateExplainabilityExportInput { + s.ExplainabilityArn = &v return s } -// SetPredictorBacktestExportJobName sets the PredictorBacktestExportJobName field's value. -func (s *CreatePredictorBacktestExportJobInput) SetPredictorBacktestExportJobName(v string) *CreatePredictorBacktestExportJobInput { - s.PredictorBacktestExportJobName = &v +// SetExplainabilityExportName sets the ExplainabilityExportName field's value. +func (s *CreateExplainabilityExportInput) SetExplainabilityExportName(v string) *CreateExplainabilityExportInput { + s.ExplainabilityExportName = &v return s } // SetTags sets the Tags field's value. -func (s *CreatePredictorBacktestExportJobInput) SetTags(v []*Tag) *CreatePredictorBacktestExportJobInput { +func (s *CreateExplainabilityExportInput) SetTags(v []*Tag) *CreateExplainabilityExportInput { s.Tags = v return s } -type CreatePredictorBacktestExportJobOutput struct { +type CreateExplainabilityExportOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the predictor backtest export job that - // you want to export. - PredictorBacktestExportJobArn *string `type:"string"` + // The Amazon Resource Name (ARN) of the export. + ExplainabilityExportArn *string `type:"string"` } // String returns the string representation. @@ -5058,7 +6322,7 @@ type CreatePredictorBacktestExportJobOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreatePredictorBacktestExportJobOutput) String() string { +func (s CreateExplainabilityExportOutput) String() string { return awsutil.Prettify(s) } @@ -5067,140 +6331,263 @@ func (s CreatePredictorBacktestExportJobOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreatePredictorBacktestExportJobOutput) GoString() string { +func (s CreateExplainabilityExportOutput) GoString() string { return s.String() } -// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value. -func (s *CreatePredictorBacktestExportJobOutput) SetPredictorBacktestExportJobArn(v string) *CreatePredictorBacktestExportJobOutput { - s.PredictorBacktestExportJobArn = &v +// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value. +func (s *CreateExplainabilityExportOutput) SetExplainabilityExportArn(v string) *CreateExplainabilityExportOutput { + s.ExplainabilityExportArn = &v return s } -type CreatePredictorInput struct { +type CreateExplainabilityInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the algorithm to use for model training. - // Required if PerformAutoML is not set to true. - // - // Supported algorithms: - // - // * arn:aws:forecast:::algorithm/ARIMA - // - // * arn:aws:forecast:::algorithm/CNN-QR - // - // * arn:aws:forecast:::algorithm/Deep_AR_Plus - // - // * arn:aws:forecast:::algorithm/ETS - // - // * arn:aws:forecast:::algorithm/NPTS - // - // * arn:aws:forecast:::algorithm/Prophet - AlgorithmArn *string `type:"string"` - - // - // The LatencyOptimized AutoML override strategy is only available in private - // beta. Contact AWS Support or your account manager to learn more about access - // privileges. - // - // Used to overide the default AutoML strategy, which is to optimize predictor - // accuracy. To apply an AutoML strategy that minimizes training time, use LatencyOptimized. - // - // This parameter is only valid for predictors trained using AutoML. - AutoMLOverrideStrategy *string `type:"string" enum:"AutoMLOverrideStrategy"` - - // An AWS Key Management Service (KMS) key and the AWS Identity and Access Management - // (IAM) role that Amazon Forecast can assume to access the key. - EncryptionConfig *EncryptionConfig `type:"structure"` + // The source of your training data, an AWS Identity and Access Management (IAM) + // role that allows Amazon Forecast to access the data and, optionally, an AWS + // Key Management Service (KMS) key. This object is submitted in the CreateDatasetImportJob + // request. + DataSource *DataSource `type:"structure"` - // Used to override the default evaluation parameters of the specified algorithm. - // Amazon Forecast evaluates a predictor by splitting a dataset into training - // data and testing data. The evaluation parameters define how to perform the - // split and the number of iterations. - EvaluationParameters *EvaluationParameters `type:"structure"` + // Create an Expainability visualization that is viewable within the AWS console. + EnableVisualization *bool `type:"boolean"` - // The featurization configuration. - // - // FeaturizationConfig is a required field - FeaturizationConfig *FeaturizationConfig `type:"structure" required:"true"` + // If TimePointGranularity is set to SPECIFIC, define the last time point for + // the Explainability. + EndDateTime *string `type:"string"` - // Specifies the number of time-steps that the model is trained to predict. - // The forecast horizon is also called the prediction length. + // The configuration settings that define the granularity of time series and + // time points for the Explainability. // - // For example, if you configure a dataset for daily data collection (using - // the DataFrequency parameter of the CreateDataset operation) and set the forecast - // horizon to 10, the model returns predictions for 10 days. - // - // The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the - // TARGET_TIME_SERIES dataset length. - // - // ForecastHorizon is a required field - ForecastHorizon *int64 `type:"integer" required:"true"` + // ExplainabilityConfig is a required field + ExplainabilityConfig *ExplainabilityConfig `type:"structure" required:"true"` - // Specifies the forecast types used to train a predictor. You can specify up - // to five forecast types. Forecast types can be quantiles from 0.01 to 0.99, - // by increments of 0.01 or higher. You can also specify the mean forecast with - // mean. + // A unique name for the Explainability. // - // The default value is ["0.10", "0.50", "0.9"]. - ForecastTypes []*string `min:"1" type:"list"` + // ExplainabilityName is a required field + ExplainabilityName *string `min:"1" type:"string" required:"true"` - // Provides hyperparameter override values for the algorithm. If you don't provide - // this parameter, Amazon Forecast uses default values. The individual algorithms - // specify which hyperparameters support hyperparameter optimization (HPO). - // For more information, see aws-forecast-choosing-recipes. + // The Amazon Resource Name (ARN) of the Predictor or Forecast used to create + // the Explainability. // - // If you included the HPOConfig object, you must set PerformHPO to true. - HPOConfig *HyperParameterTuningJobConfig `type:"structure"` + // ResourceArn is a required field + ResourceArn *string `type:"string" required:"true"` - // Describes the dataset group that contains the data to use to train the predictor. - // - // InputDataConfig is a required field - InputDataConfig *InputDataConfig `type:"structure" required:"true"` + // Defines the fields of a dataset. You specify this object in the CreateDataset + // request. + Schema *Schema `type:"structure"` - // The accuracy metric used to optimize the predictor. - OptimizationMetric *string `type:"string" enum:"OptimizationMetric"` + // If TimePointGranularity is set to SPECIFIC, define the first point for the + // Explainability. + StartDateTime *string `type:"string"` - // Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates - // the algorithms it provides and chooses the best algorithm and configuration - // for your training dataset. + // Optional metadata to help you categorize and organize your resources. Each + // tag consists of a key and an optional value, both of which you define. Tag + // keys and values are case sensitive. // - // The default value is false. In this case, you are required to specify an - // algorithm. + // The following restrictions apply to tags: // - // Set PerformAutoML to true to have Amazon Forecast perform AutoML. This is - // a good option if you aren't sure which algorithm is suitable for your training - // data. In this case, PerformHPO must be false. - PerformAutoML *bool `type:"boolean"` - - // Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter - // values for your training data. The process of performing HPO is known as - // running a hyperparameter tuning job. + // * For each resource, each tag key must be unique and each tag key must + // have one value. // - // The default value is false. In this case, Amazon Forecast uses default hyperparameter - // values from the chosen algorithm. + // * Maximum number of tags per resource: 50. // - // To override the default values, set PerformHPO to true and, optionally, supply - // the HyperParameterTuningJobConfig object. The tuning job specifies a metric - // to optimize, which hyperparameters participate in tuning, and the valid range - // for each tunable hyperparameter. In this case, you are required to specify - // an algorithm and PerformAutoML must be false. + // * Maximum key length: 128 Unicode characters in UTF-8. // - // The following algorithms support HPO: + // * Maximum value length: 256 Unicode characters in UTF-8. // - // * DeepAR+ + // * Accepted characters: all letters and numbers, spaces representable in + // UTF-8, and + - = . _ : / @. If your tagging schema is used across other + // services and resources, the character restrictions of those services also + // apply. // - // * CNN-QR - PerformHPO *bool `type:"boolean"` + // * Key prefixes cannot include any upper or lowercase combination of aws: + // or AWS:. Values can have this prefix. If a tag value has aws as its prefix + // but the key does not, Forecast considers it to be a user tag and will + // count against the limit of 50 tags. Tags with only the key prefix of aws + // do not count against your tags per resource limit. You cannot edit or + // delete tag keys with this prefix. + Tags []*Tag `type:"list"` +} - // A name for the predictor. +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateExplainabilityInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateExplainabilityInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateExplainabilityInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateExplainabilityInput"} + if s.ExplainabilityConfig == nil { + invalidParams.Add(request.NewErrParamRequired("ExplainabilityConfig")) + } + if s.ExplainabilityName == nil { + invalidParams.Add(request.NewErrParamRequired("ExplainabilityName")) + } + if s.ExplainabilityName != nil && len(*s.ExplainabilityName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ExplainabilityName", 1)) + } + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.DataSource != nil { + if err := s.DataSource.Validate(); err != nil { + invalidParams.AddNested("DataSource", err.(request.ErrInvalidParams)) + } + } + if s.ExplainabilityConfig != nil { + if err := s.ExplainabilityConfig.Validate(); err != nil { + invalidParams.AddNested("ExplainabilityConfig", err.(request.ErrInvalidParams)) + } + } + if s.Schema != nil { + if err := s.Schema.Validate(); err != nil { + invalidParams.AddNested("Schema", err.(request.ErrInvalidParams)) + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDataSource sets the DataSource field's value. +func (s *CreateExplainabilityInput) SetDataSource(v *DataSource) *CreateExplainabilityInput { + s.DataSource = v + return s +} + +// SetEnableVisualization sets the EnableVisualization field's value. +func (s *CreateExplainabilityInput) SetEnableVisualization(v bool) *CreateExplainabilityInput { + s.EnableVisualization = &v + return s +} + +// SetEndDateTime sets the EndDateTime field's value. +func (s *CreateExplainabilityInput) SetEndDateTime(v string) *CreateExplainabilityInput { + s.EndDateTime = &v + return s +} + +// SetExplainabilityConfig sets the ExplainabilityConfig field's value. +func (s *CreateExplainabilityInput) SetExplainabilityConfig(v *ExplainabilityConfig) *CreateExplainabilityInput { + s.ExplainabilityConfig = v + return s +} + +// SetExplainabilityName sets the ExplainabilityName field's value. +func (s *CreateExplainabilityInput) SetExplainabilityName(v string) *CreateExplainabilityInput { + s.ExplainabilityName = &v + return s +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *CreateExplainabilityInput) SetResourceArn(v string) *CreateExplainabilityInput { + s.ResourceArn = &v + return s +} + +// SetSchema sets the Schema field's value. +func (s *CreateExplainabilityInput) SetSchema(v *Schema) *CreateExplainabilityInput { + s.Schema = v + return s +} + +// SetStartDateTime sets the StartDateTime field's value. +func (s *CreateExplainabilityInput) SetStartDateTime(v string) *CreateExplainabilityInput { + s.StartDateTime = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateExplainabilityInput) SetTags(v []*Tag) *CreateExplainabilityInput { + s.Tags = v + return s +} + +type CreateExplainabilityOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the Explainability. + ExplainabilityArn *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateExplainabilityOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateExplainabilityOutput) GoString() string { + return s.String() +} + +// SetExplainabilityArn sets the ExplainabilityArn field's value. +func (s *CreateExplainabilityOutput) SetExplainabilityArn(v string) *CreateExplainabilityOutput { + s.ExplainabilityArn = &v + return s +} + +type CreateForecastExportJobInput struct { + _ struct{} `type:"structure"` + + // The location where you want to save the forecast and an AWS Identity and + // Access Management (IAM) role that Amazon Forecast can assume to access the + // location. The forecast must be exported to an Amazon S3 bucket. // - // PredictorName is a required field - PredictorName *string `min:"1" type:"string" required:"true"` + // If encryption is used, Destination must include an AWS Key Management Service + // (KMS) key. The IAM role must allow Amazon Forecast permission to access the + // key. + // + // Destination is a required field + Destination *DataDestination `type:"structure" required:"true"` - // The optional metadata that you apply to the predictor to help you categorize - // and organize them. Each tag consists of a key and an optional value, both - // of which you define. + // The Amazon Resource Name (ARN) of the forecast that you want to export. + // + // ForecastArn is a required field + ForecastArn *string `type:"string" required:"true"` + + // The name for the forecast export job. + // + // ForecastExportJobName is a required field + ForecastExportJobName *string `min:"1" type:"string" required:"true"` + + // The optional metadata that you apply to the forecast export job to help you + // categorize and organize them. Each tag consists of a key and an optional + // value, both of which you define. // // The following basic restrictions apply to tags: // @@ -5228,11 +6615,1365 @@ type CreatePredictorInput struct { // with only the key prefix of aws do not count against your tags per resource // limit. Tags []*Tag `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateForecastExportJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateForecastExportJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateForecastExportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateForecastExportJobInput"} + if s.Destination == nil { + invalidParams.Add(request.NewErrParamRequired("Destination")) + } + if s.ForecastArn == nil { + invalidParams.Add(request.NewErrParamRequired("ForecastArn")) + } + if s.ForecastExportJobName == nil { + invalidParams.Add(request.NewErrParamRequired("ForecastExportJobName")) + } + if s.ForecastExportJobName != nil && len(*s.ForecastExportJobName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ForecastExportJobName", 1)) + } + if s.Destination != nil { + if err := s.Destination.Validate(); err != nil { + invalidParams.AddNested("Destination", err.(request.ErrInvalidParams)) + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDestination sets the Destination field's value. +func (s *CreateForecastExportJobInput) SetDestination(v *DataDestination) *CreateForecastExportJobInput { + s.Destination = v + return s +} + +// SetForecastArn sets the ForecastArn field's value. +func (s *CreateForecastExportJobInput) SetForecastArn(v string) *CreateForecastExportJobInput { + s.ForecastArn = &v + return s +} + +// SetForecastExportJobName sets the ForecastExportJobName field's value. +func (s *CreateForecastExportJobInput) SetForecastExportJobName(v string) *CreateForecastExportJobInput { + s.ForecastExportJobName = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateForecastExportJobInput) SetTags(v []*Tag) *CreateForecastExportJobInput { + s.Tags = v + return s +} + +type CreateForecastExportJobOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the export job. + ForecastExportJobArn *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateForecastExportJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateForecastExportJobOutput) GoString() string { + return s.String() +} + +// SetForecastExportJobArn sets the ForecastExportJobArn field's value. +func (s *CreateForecastExportJobOutput) SetForecastExportJobArn(v string) *CreateForecastExportJobOutput { + s.ForecastExportJobArn = &v + return s +} + +type CreateForecastInput struct { + _ struct{} `type:"structure"` + + // A name for the forecast. + // + // ForecastName is a required field + ForecastName *string `min:"1" type:"string" required:"true"` + + // The quantiles at which probabilistic forecasts are generated. You can currently + // specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99 + // (increments of .01 only) and mean. The mean forecast is different from the + // median (0.50) when the distribution is not symmetric (for example, Beta and + // Negative Binomial). The default value is ["0.1", "0.5", "0.9"]. + ForecastTypes []*string `min:"1" type:"list"` + + // The Amazon Resource Name (ARN) of the predictor to use to generate the forecast. + // + // PredictorArn is a required field + PredictorArn *string `type:"string" required:"true"` + + // The optional metadata that you apply to the forecast to help you categorize + // and organize them. Each tag consists of a key and an optional value, both + // of which you define. + // + // The following basic restrictions apply to tags: + // + // * Maximum number of tags per resource - 50. + // + // * For each resource, each tag key must be unique, and each tag key can + // have only one value. + // + // * Maximum key length - 128 Unicode characters in UTF-8. + // + // * Maximum value length - 256 Unicode characters in UTF-8. + // + // * If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable + // in UTF-8, and the following characters: + - = . _ : / @. + // + // * Tag keys and values are case sensitive. + // + // * Do not use aws:, AWS:, or any upper or lowercase combination of such + // as a prefix for keys as it is reserved for AWS use. You cannot edit or + // delete tag keys with this prefix. Values can have this prefix. If a tag + // value has aws as its prefix but the key does not, then Forecast considers + // it to be a user tag and will count against the limit of 50 tags. Tags + // with only the key prefix of aws do not count against your tags per resource + // limit. + Tags []*Tag `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateForecastInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateForecastInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateForecastInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateForecastInput"} + if s.ForecastName == nil { + invalidParams.Add(request.NewErrParamRequired("ForecastName")) + } + if s.ForecastName != nil && len(*s.ForecastName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ForecastName", 1)) + } + if s.ForecastTypes != nil && len(s.ForecastTypes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ForecastTypes", 1)) + } + if s.PredictorArn == nil { + invalidParams.Add(request.NewErrParamRequired("PredictorArn")) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetForecastName sets the ForecastName field's value. +func (s *CreateForecastInput) SetForecastName(v string) *CreateForecastInput { + s.ForecastName = &v + return s +} + +// SetForecastTypes sets the ForecastTypes field's value. +func (s *CreateForecastInput) SetForecastTypes(v []*string) *CreateForecastInput { + s.ForecastTypes = v + return s +} + +// SetPredictorArn sets the PredictorArn field's value. +func (s *CreateForecastInput) SetPredictorArn(v string) *CreateForecastInput { + s.PredictorArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateForecastInput) SetTags(v []*Tag) *CreateForecastInput { + s.Tags = v + return s +} + +type CreateForecastOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the forecast. + ForecastArn *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateForecastOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateForecastOutput) GoString() string { + return s.String() +} + +// SetForecastArn sets the ForecastArn field's value. +func (s *CreateForecastOutput) SetForecastArn(v string) *CreateForecastOutput { + s.ForecastArn = &v + return s +} + +type CreatePredictorBacktestExportJobInput struct { + _ struct{} `type:"structure"` + + // The destination for an export job. Provide an S3 path, an AWS Identity and + // Access Management (IAM) role that allows Amazon Forecast to access the location, + // and an AWS Key Management Service (KMS) key (optional). + // + // Destination is a required field + Destination *DataDestination `type:"structure" required:"true"` + + // The Amazon Resource Name (ARN) of the predictor that you want to export. + // + // PredictorArn is a required field + PredictorArn *string `type:"string" required:"true"` + + // The name for the backtest export job. + // + // PredictorBacktestExportJobName is a required field + PredictorBacktestExportJobName *string `min:"1" type:"string" required:"true"` + + // Optional metadata to help you categorize and organize your backtests. Each + // tag consists of a key and an optional value, both of which you define. Tag + // keys and values are case sensitive. + // + // The following restrictions apply to tags: + // + // * For each resource, each tag key must be unique and each tag key must + // have one value. + // + // * Maximum number of tags per resource: 50. + // + // * Maximum key length: 128 Unicode characters in UTF-8. + // + // * Maximum value length: 256 Unicode characters in UTF-8. + // + // * Accepted characters: all letters and numbers, spaces representable in + // UTF-8, and + - = . _ : / @. If your tagging schema is used across other + // services and resources, the character restrictions of those services also + // apply. + // + // * Key prefixes cannot include any upper or lowercase combination of aws: + // or AWS:. Values can have this prefix. If a tag value has aws as its prefix + // but the key does not, Forecast considers it to be a user tag and will + // count against the limit of 50 tags. Tags with only the key prefix of aws + // do not count against your tags per resource limit. You cannot edit or + // delete tag keys with this prefix. + Tags []*Tag `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePredictorBacktestExportJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePredictorBacktestExportJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreatePredictorBacktestExportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreatePredictorBacktestExportJobInput"} + if s.Destination == nil { + invalidParams.Add(request.NewErrParamRequired("Destination")) + } + if s.PredictorArn == nil { + invalidParams.Add(request.NewErrParamRequired("PredictorArn")) + } + if s.PredictorBacktestExportJobName == nil { + invalidParams.Add(request.NewErrParamRequired("PredictorBacktestExportJobName")) + } + if s.PredictorBacktestExportJobName != nil && len(*s.PredictorBacktestExportJobName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PredictorBacktestExportJobName", 1)) + } + if s.Destination != nil { + if err := s.Destination.Validate(); err != nil { + invalidParams.AddNested("Destination", err.(request.ErrInvalidParams)) + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDestination sets the Destination field's value. +func (s *CreatePredictorBacktestExportJobInput) SetDestination(v *DataDestination) *CreatePredictorBacktestExportJobInput { + s.Destination = v + return s +} + +// SetPredictorArn sets the PredictorArn field's value. +func (s *CreatePredictorBacktestExportJobInput) SetPredictorArn(v string) *CreatePredictorBacktestExportJobInput { + s.PredictorArn = &v + return s +} + +// SetPredictorBacktestExportJobName sets the PredictorBacktestExportJobName field's value. +func (s *CreatePredictorBacktestExportJobInput) SetPredictorBacktestExportJobName(v string) *CreatePredictorBacktestExportJobInput { + s.PredictorBacktestExportJobName = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreatePredictorBacktestExportJobInput) SetTags(v []*Tag) *CreatePredictorBacktestExportJobInput { + s.Tags = v + return s +} + +type CreatePredictorBacktestExportJobOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the predictor backtest export job that + // you want to export. + PredictorBacktestExportJobArn *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePredictorBacktestExportJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePredictorBacktestExportJobOutput) GoString() string { + return s.String() +} + +// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value. +func (s *CreatePredictorBacktestExportJobOutput) SetPredictorBacktestExportJobArn(v string) *CreatePredictorBacktestExportJobOutput { + s.PredictorBacktestExportJobArn = &v + return s +} + +type CreatePredictorInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the algorithm to use for model training. + // Required if PerformAutoML is not set to true. + // + // Supported algorithms: + // + // * arn:aws:forecast:::algorithm/ARIMA + // + // * arn:aws:forecast:::algorithm/CNN-QR + // + // * arn:aws:forecast:::algorithm/Deep_AR_Plus + // + // * arn:aws:forecast:::algorithm/ETS + // + // * arn:aws:forecast:::algorithm/NPTS + // + // * arn:aws:forecast:::algorithm/Prophet + AlgorithmArn *string `type:"string"` + + // + // The LatencyOptimized AutoML override strategy is only available in private + // beta. Contact AWS Support or your account manager to learn more about access + // privileges. + // + // Used to overide the default AutoML strategy, which is to optimize predictor + // accuracy. To apply an AutoML strategy that minimizes training time, use LatencyOptimized. + // + // This parameter is only valid for predictors trained using AutoML. + AutoMLOverrideStrategy *string `type:"string" enum:"AutoMLOverrideStrategy"` + + // An AWS Key Management Service (KMS) key and the AWS Identity and Access Management + // (IAM) role that Amazon Forecast can assume to access the key. + EncryptionConfig *EncryptionConfig `type:"structure"` + + // Used to override the default evaluation parameters of the specified algorithm. + // Amazon Forecast evaluates a predictor by splitting a dataset into training + // data and testing data. The evaluation parameters define how to perform the + // split and the number of iterations. + EvaluationParameters *EvaluationParameters `type:"structure"` + + // The featurization configuration. + // + // FeaturizationConfig is a required field + FeaturizationConfig *FeaturizationConfig `type:"structure" required:"true"` + + // Specifies the number of time-steps that the model is trained to predict. + // The forecast horizon is also called the prediction length. + // + // For example, if you configure a dataset for daily data collection (using + // the DataFrequency parameter of the CreateDataset operation) and set the forecast + // horizon to 10, the model returns predictions for 10 days. + // + // The maximum forecast horizon is the lesser of 500 time-steps or 1/3 of the + // TARGET_TIME_SERIES dataset length. + // + // ForecastHorizon is a required field + ForecastHorizon *int64 `type:"integer" required:"true"` + + // Specifies the forecast types used to train a predictor. You can specify up + // to five forecast types. Forecast types can be quantiles from 0.01 to 0.99, + // by increments of 0.01 or higher. You can also specify the mean forecast with + // mean. + // + // The default value is ["0.10", "0.50", "0.9"]. + ForecastTypes []*string `min:"1" type:"list"` + + // Provides hyperparameter override values for the algorithm. If you don't provide + // this parameter, Amazon Forecast uses default values. The individual algorithms + // specify which hyperparameters support hyperparameter optimization (HPO). + // For more information, see aws-forecast-choosing-recipes. + // + // If you included the HPOConfig object, you must set PerformHPO to true. + HPOConfig *HyperParameterTuningJobConfig `type:"structure"` + + // Describes the dataset group that contains the data to use to train the predictor. + // + // InputDataConfig is a required field + InputDataConfig *InputDataConfig `type:"structure" required:"true"` + + // The accuracy metric used to optimize the predictor. + OptimizationMetric *string `type:"string" enum:"OptimizationMetric"` + + // Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates + // the algorithms it provides and chooses the best algorithm and configuration + // for your training dataset. + // + // The default value is false. In this case, you are required to specify an + // algorithm. + // + // Set PerformAutoML to true to have Amazon Forecast perform AutoML. This is + // a good option if you aren't sure which algorithm is suitable for your training + // data. In this case, PerformHPO must be false. + PerformAutoML *bool `type:"boolean"` + + // Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter + // values for your training data. The process of performing HPO is known as + // running a hyperparameter tuning job. + // + // The default value is false. In this case, Amazon Forecast uses default hyperparameter + // values from the chosen algorithm. + // + // To override the default values, set PerformHPO to true and, optionally, supply + // the HyperParameterTuningJobConfig object. The tuning job specifies a metric + // to optimize, which hyperparameters participate in tuning, and the valid range + // for each tunable hyperparameter. In this case, you are required to specify + // an algorithm and PerformAutoML must be false. + // + // The following algorithms support HPO: + // + // * DeepAR+ + // + // * CNN-QR + PerformHPO *bool `type:"boolean"` + + // A name for the predictor. + // + // PredictorName is a required field + PredictorName *string `min:"1" type:"string" required:"true"` + + // The optional metadata that you apply to the predictor to help you categorize + // and organize them. Each tag consists of a key and an optional value, both + // of which you define. + // + // The following basic restrictions apply to tags: + // + // * Maximum number of tags per resource - 50. + // + // * For each resource, each tag key must be unique, and each tag key can + // have only one value. + // + // * Maximum key length - 128 Unicode characters in UTF-8. + // + // * Maximum value length - 256 Unicode characters in UTF-8. + // + // * If your tagging schema is used across multiple services and resources, + // remember that other services may have restrictions on allowed characters. + // Generally allowed characters are: letters, numbers, and spaces representable + // in UTF-8, and the following characters: + - = . _ : / @. + // + // * Tag keys and values are case sensitive. + // + // * Do not use aws:, AWS:, or any upper or lowercase combination of such + // as a prefix for keys as it is reserved for AWS use. You cannot edit or + // delete tag keys with this prefix. Values can have this prefix. If a tag + // value has aws as its prefix but the key does not, then Forecast considers + // it to be a user tag and will count against the limit of 50 tags. Tags + // with only the key prefix of aws do not count against your tags per resource + // limit. + Tags []*Tag `type:"list"` + + // The hyperparameters to override for model training. The hyperparameters that + // you can override are listed in the individual algorithms. For the list of + // supported algorithms, see aws-forecast-choosing-recipes. + TrainingParameters map[string]*string `type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePredictorInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePredictorInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreatePredictorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreatePredictorInput"} + if s.FeaturizationConfig == nil { + invalidParams.Add(request.NewErrParamRequired("FeaturizationConfig")) + } + if s.ForecastHorizon == nil { + invalidParams.Add(request.NewErrParamRequired("ForecastHorizon")) + } + if s.ForecastTypes != nil && len(s.ForecastTypes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ForecastTypes", 1)) + } + if s.InputDataConfig == nil { + invalidParams.Add(request.NewErrParamRequired("InputDataConfig")) + } + if s.PredictorName == nil { + invalidParams.Add(request.NewErrParamRequired("PredictorName")) + } + if s.PredictorName != nil && len(*s.PredictorName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("PredictorName", 1)) + } + if s.EncryptionConfig != nil { + if err := s.EncryptionConfig.Validate(); err != nil { + invalidParams.AddNested("EncryptionConfig", err.(request.ErrInvalidParams)) + } + } + if s.FeaturizationConfig != nil { + if err := s.FeaturizationConfig.Validate(); err != nil { + invalidParams.AddNested("FeaturizationConfig", err.(request.ErrInvalidParams)) + } + } + if s.HPOConfig != nil { + if err := s.HPOConfig.Validate(); err != nil { + invalidParams.AddNested("HPOConfig", err.(request.ErrInvalidParams)) + } + } + if s.InputDataConfig != nil { + if err := s.InputDataConfig.Validate(); err != nil { + invalidParams.AddNested("InputDataConfig", err.(request.ErrInvalidParams)) + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAlgorithmArn sets the AlgorithmArn field's value. +func (s *CreatePredictorInput) SetAlgorithmArn(v string) *CreatePredictorInput { + s.AlgorithmArn = &v + return s +} + +// SetAutoMLOverrideStrategy sets the AutoMLOverrideStrategy field's value. +func (s *CreatePredictorInput) SetAutoMLOverrideStrategy(v string) *CreatePredictorInput { + s.AutoMLOverrideStrategy = &v + return s +} + +// SetEncryptionConfig sets the EncryptionConfig field's value. +func (s *CreatePredictorInput) SetEncryptionConfig(v *EncryptionConfig) *CreatePredictorInput { + s.EncryptionConfig = v + return s +} + +// SetEvaluationParameters sets the EvaluationParameters field's value. +func (s *CreatePredictorInput) SetEvaluationParameters(v *EvaluationParameters) *CreatePredictorInput { + s.EvaluationParameters = v + return s +} + +// SetFeaturizationConfig sets the FeaturizationConfig field's value. +func (s *CreatePredictorInput) SetFeaturizationConfig(v *FeaturizationConfig) *CreatePredictorInput { + s.FeaturizationConfig = v + return s +} + +// SetForecastHorizon sets the ForecastHorizon field's value. +func (s *CreatePredictorInput) SetForecastHorizon(v int64) *CreatePredictorInput { + s.ForecastHorizon = &v + return s +} + +// SetForecastTypes sets the ForecastTypes field's value. +func (s *CreatePredictorInput) SetForecastTypes(v []*string) *CreatePredictorInput { + s.ForecastTypes = v + return s +} + +// SetHPOConfig sets the HPOConfig field's value. +func (s *CreatePredictorInput) SetHPOConfig(v *HyperParameterTuningJobConfig) *CreatePredictorInput { + s.HPOConfig = v + return s +} + +// SetInputDataConfig sets the InputDataConfig field's value. +func (s *CreatePredictorInput) SetInputDataConfig(v *InputDataConfig) *CreatePredictorInput { + s.InputDataConfig = v + return s +} + +// SetOptimizationMetric sets the OptimizationMetric field's value. +func (s *CreatePredictorInput) SetOptimizationMetric(v string) *CreatePredictorInput { + s.OptimizationMetric = &v + return s +} + +// SetPerformAutoML sets the PerformAutoML field's value. +func (s *CreatePredictorInput) SetPerformAutoML(v bool) *CreatePredictorInput { + s.PerformAutoML = &v + return s +} + +// SetPerformHPO sets the PerformHPO field's value. +func (s *CreatePredictorInput) SetPerformHPO(v bool) *CreatePredictorInput { + s.PerformHPO = &v + return s +} + +// SetPredictorName sets the PredictorName field's value. +func (s *CreatePredictorInput) SetPredictorName(v string) *CreatePredictorInput { + s.PredictorName = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreatePredictorInput) SetTags(v []*Tag) *CreatePredictorInput { + s.Tags = v + return s +} + +// SetTrainingParameters sets the TrainingParameters field's value. +func (s *CreatePredictorInput) SetTrainingParameters(v map[string]*string) *CreatePredictorInput { + s.TrainingParameters = v + return s +} + +type CreatePredictorOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the predictor. + PredictorArn *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePredictorOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreatePredictorOutput) GoString() string { + return s.String() +} + +// SetPredictorArn sets the PredictorArn field's value. +func (s *CreatePredictorOutput) SetPredictorArn(v string) *CreatePredictorOutput { + s.PredictorArn = &v + return s +} + +// The data configuration for your dataset group and any additional datasets. +type DataConfig struct { + _ struct{} `type:"structure"` + + // Additional built-in datasets like Holidays and the Weather Index. + AdditionalDatasets []*AdditionalDataset `min:"1" type:"list"` + + // Aggregation and filling options for attributes in your dataset group. + AttributeConfigs []*AttributeConfig `min:"1" type:"list"` + + // The ARN of the dataset group used to train the predictor. + // + // DatasetGroupArn is a required field + DatasetGroupArn *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DataConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DataConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DataConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DataConfig"} + if s.AdditionalDatasets != nil && len(s.AdditionalDatasets) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AdditionalDatasets", 1)) + } + if s.AttributeConfigs != nil && len(s.AttributeConfigs) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AttributeConfigs", 1)) + } + if s.DatasetGroupArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn")) + } + if s.AdditionalDatasets != nil { + for i, v := range s.AdditionalDatasets { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AdditionalDatasets", i), err.(request.ErrInvalidParams)) + } + } + } + if s.AttributeConfigs != nil { + for i, v := range s.AttributeConfigs { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AttributeConfigs", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAdditionalDatasets sets the AdditionalDatasets field's value. +func (s *DataConfig) SetAdditionalDatasets(v []*AdditionalDataset) *DataConfig { + s.AdditionalDatasets = v + return s +} + +// SetAttributeConfigs sets the AttributeConfigs field's value. +func (s *DataConfig) SetAttributeConfigs(v []*AttributeConfig) *DataConfig { + s.AttributeConfigs = v + return s +} + +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *DataConfig) SetDatasetGroupArn(v string) *DataConfig { + s.DatasetGroupArn = &v + return s +} + +// The destination for an export job. Provide an S3 path, an AWS Identity and +// Access Management (IAM) role that allows Amazon Forecast to access the location, +// and an AWS Key Management Service (KMS) key (optional). +type DataDestination struct { + _ struct{} `type:"structure"` + + // The path to an Amazon Simple Storage Service (Amazon S3) bucket along with + // the credentials to access the bucket. + // + // S3Config is a required field + S3Config *S3Config `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DataDestination) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DataDestination) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DataDestination) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DataDestination"} + if s.S3Config == nil { + invalidParams.Add(request.NewErrParamRequired("S3Config")) + } + if s.S3Config != nil { + if err := s.S3Config.Validate(); err != nil { + invalidParams.AddNested("S3Config", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetS3Config sets the S3Config field's value. +func (s *DataDestination) SetS3Config(v *S3Config) *DataDestination { + s.S3Config = v + return s +} + +// The source of your training data, an AWS Identity and Access Management (IAM) +// role that allows Amazon Forecast to access the data and, optionally, an AWS +// Key Management Service (KMS) key. This object is submitted in the CreateDatasetImportJob +// request. +type DataSource struct { + _ struct{} `type:"structure"` + + // The path to the training data stored in an Amazon Simple Storage Service + // (Amazon S3) bucket along with the credentials to access the data. + // + // S3Config is a required field + S3Config *S3Config `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DataSource) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DataSource) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DataSource) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DataSource"} + if s.S3Config == nil { + invalidParams.Add(request.NewErrParamRequired("S3Config")) + } + if s.S3Config != nil { + if err := s.S3Config.Validate(); err != nil { + invalidParams.AddNested("S3Config", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetS3Config sets the S3Config field's value. +func (s *DataSource) SetS3Config(v *S3Config) *DataSource { + s.S3Config = v + return s +} + +// Provides a summary of the dataset group properties used in the ListDatasetGroups +// operation. To get the complete set of properties, call the DescribeDatasetGroup +// operation, and provide the DatasetGroupArn. +type DatasetGroupSummary struct { + _ struct{} `type:"structure"` + + // When the dataset group was created. + CreationTime *time.Time `type:"timestamp"` + + // The Amazon Resource Name (ARN) of the dataset group. + DatasetGroupArn *string `type:"string"` + + // The name of the dataset group. + DatasetGroupName *string `min:"1" type:"string"` + + // When the dataset group was created or last updated from a call to the UpdateDatasetGroup + // operation. While the dataset group is being updated, LastModificationTime + // is the current time of the ListDatasetGroups call. + LastModificationTime *time.Time `type:"timestamp"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DatasetGroupSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DatasetGroupSummary) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *DatasetGroupSummary) SetCreationTime(v time.Time) *DatasetGroupSummary { + s.CreationTime = &v + return s +} + +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *DatasetGroupSummary) SetDatasetGroupArn(v string) *DatasetGroupSummary { + s.DatasetGroupArn = &v + return s +} + +// SetDatasetGroupName sets the DatasetGroupName field's value. +func (s *DatasetGroupSummary) SetDatasetGroupName(v string) *DatasetGroupSummary { + s.DatasetGroupName = &v + return s +} + +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DatasetGroupSummary) SetLastModificationTime(v time.Time) *DatasetGroupSummary { + s.LastModificationTime = &v + return s +} + +// Provides a summary of the dataset import job properties used in the ListDatasetImportJobs +// operation. To get the complete set of properties, call the DescribeDatasetImportJob +// operation, and provide the DatasetImportJobArn. +type DatasetImportJobSummary struct { + _ struct{} `type:"structure"` + + // When the dataset import job was created. + CreationTime *time.Time `type:"timestamp"` + + // The location of the training data to import and an AWS Identity and Access + // Management (IAM) role that Amazon Forecast can assume to access the data. + // The training data must be stored in an Amazon S3 bucket. + // + // If encryption is used, DataSource includes an AWS Key Management Service + // (KMS) key. + DataSource *DataSource `type:"structure"` + + // The Amazon Resource Name (ARN) of the dataset import job. + DatasetImportJobArn *string `type:"string"` + + // The name of the dataset import job. + DatasetImportJobName *string `min:"1" type:"string"` + + // The last time the resource was modified. The timestamp depends on the status + // of the job: + // + // * CREATE_PENDING - The CreationTime. + // + // * CREATE_IN_PROGRESS - The current timestamp. + // + // * CREATE_STOPPING - The current timestamp. + // + // * CREATE_STOPPED - When the job stopped. + // + // * ACTIVE or CREATE_FAILED - When the job finished or failed. + LastModificationTime *time.Time `type:"timestamp"` + + // If an error occurred, an informational message about the error. + Message *string `type:"string"` + + // The status of the dataset import job. States include: + // + // * ACTIVE + // + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // + // * CREATE_STOPPING, CREATE_STOPPED + Status *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DatasetImportJobSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DatasetImportJobSummary) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *DatasetImportJobSummary) SetCreationTime(v time.Time) *DatasetImportJobSummary { + s.CreationTime = &v + return s +} + +// SetDataSource sets the DataSource field's value. +func (s *DatasetImportJobSummary) SetDataSource(v *DataSource) *DatasetImportJobSummary { + s.DataSource = v + return s +} + +// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. +func (s *DatasetImportJobSummary) SetDatasetImportJobArn(v string) *DatasetImportJobSummary { + s.DatasetImportJobArn = &v + return s +} + +// SetDatasetImportJobName sets the DatasetImportJobName field's value. +func (s *DatasetImportJobSummary) SetDatasetImportJobName(v string) *DatasetImportJobSummary { + s.DatasetImportJobName = &v + return s +} + +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DatasetImportJobSummary) SetLastModificationTime(v time.Time) *DatasetImportJobSummary { + s.LastModificationTime = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *DatasetImportJobSummary) SetMessage(v string) *DatasetImportJobSummary { + s.Message = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DatasetImportJobSummary) SetStatus(v string) *DatasetImportJobSummary { + s.Status = &v + return s +} + +// Provides a summary of the dataset properties used in the ListDatasets operation. +// To get the complete set of properties, call the DescribeDataset operation, +// and provide the DatasetArn. +type DatasetSummary struct { + _ struct{} `type:"structure"` + + // When the dataset was created. + CreationTime *time.Time `type:"timestamp"` + + // The Amazon Resource Name (ARN) of the dataset. + DatasetArn *string `type:"string"` + + // The name of the dataset. + DatasetName *string `min:"1" type:"string"` + + // The dataset type. + DatasetType *string `type:"string" enum:"DatasetType"` + + // The domain associated with the dataset. + Domain *string `type:"string" enum:"Domain"` + + // When you create a dataset, LastModificationTime is the same as CreationTime. + // While data is being imported to the dataset, LastModificationTime is the + // current time of the ListDatasets call. After a CreateDatasetImportJob operation + // has finished, LastModificationTime is when the import job completed or failed. + LastModificationTime *time.Time `type:"timestamp"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DatasetSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DatasetSummary) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *DatasetSummary) SetCreationTime(v time.Time) *DatasetSummary { + s.CreationTime = &v + return s +} + +// SetDatasetArn sets the DatasetArn field's value. +func (s *DatasetSummary) SetDatasetArn(v string) *DatasetSummary { + s.DatasetArn = &v + return s +} + +// SetDatasetName sets the DatasetName field's value. +func (s *DatasetSummary) SetDatasetName(v string) *DatasetSummary { + s.DatasetName = &v + return s +} + +// SetDatasetType sets the DatasetType field's value. +func (s *DatasetSummary) SetDatasetType(v string) *DatasetSummary { + s.DatasetType = &v + return s +} + +// SetDomain sets the Domain field's value. +func (s *DatasetSummary) SetDomain(v string) *DatasetSummary { + s.Domain = &v + return s +} + +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DatasetSummary) SetLastModificationTime(v time.Time) *DatasetSummary { + s.LastModificationTime = &v + return s +} + +type DeleteDatasetGroupInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the dataset group to delete. + // + // DatasetGroupArn is a required field + DatasetGroupArn *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDatasetGroupInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDatasetGroupInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteDatasetGroupInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteDatasetGroupInput"} + if s.DatasetGroupArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *DeleteDatasetGroupInput) SetDatasetGroupArn(v string) *DeleteDatasetGroupInput { + s.DatasetGroupArn = &v + return s +} + +type DeleteDatasetGroupOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDatasetGroupOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDatasetGroupOutput) GoString() string { + return s.String() +} + +type DeleteDatasetImportJobInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the dataset import job to delete. + // + // DatasetImportJobArn is a required field + DatasetImportJobArn *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDatasetImportJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDatasetImportJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteDatasetImportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteDatasetImportJobInput"} + if s.DatasetImportJobArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetImportJobArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. +func (s *DeleteDatasetImportJobInput) SetDatasetImportJobArn(v string) *DeleteDatasetImportJobInput { + s.DatasetImportJobArn = &v + return s +} - // The hyperparameters to override for model training. The hyperparameters that - // you can override are listed in the individual algorithms. For the list of - // supported algorithms, see aws-forecast-choosing-recipes. - TrainingParameters map[string]*string `type:"map"` +type DeleteDatasetImportJobOutput struct { + _ struct{} `type:"structure"` } // String returns the string representation. @@ -5240,7 +7981,7 @@ type CreatePredictorInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreatePredictorInput) String() string { +func (s DeleteDatasetImportJobOutput) String() string { return awsutil.Prettify(s) } @@ -5249,163 +7990,126 @@ func (s CreatePredictorInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreatePredictorInput) GoString() string { +func (s DeleteDatasetImportJobOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *CreatePredictorInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "CreatePredictorInput"} - if s.FeaturizationConfig == nil { - invalidParams.Add(request.NewErrParamRequired("FeaturizationConfig")) - } - if s.ForecastHorizon == nil { - invalidParams.Add(request.NewErrParamRequired("ForecastHorizon")) - } - if s.ForecastTypes != nil && len(s.ForecastTypes) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ForecastTypes", 1)) - } - if s.InputDataConfig == nil { - invalidParams.Add(request.NewErrParamRequired("InputDataConfig")) - } - if s.PredictorName == nil { - invalidParams.Add(request.NewErrParamRequired("PredictorName")) - } - if s.PredictorName != nil && len(*s.PredictorName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("PredictorName", 1)) - } - if s.EncryptionConfig != nil { - if err := s.EncryptionConfig.Validate(); err != nil { - invalidParams.AddNested("EncryptionConfig", err.(request.ErrInvalidParams)) - } - } - if s.FeaturizationConfig != nil { - if err := s.FeaturizationConfig.Validate(); err != nil { - invalidParams.AddNested("FeaturizationConfig", err.(request.ErrInvalidParams)) - } - } - if s.HPOConfig != nil { - if err := s.HPOConfig.Validate(); err != nil { - invalidParams.AddNested("HPOConfig", err.(request.ErrInvalidParams)) - } - } - if s.InputDataConfig != nil { - if err := s.InputDataConfig.Validate(); err != nil { - invalidParams.AddNested("InputDataConfig", err.(request.ErrInvalidParams)) - } - } - if s.Tags != nil { - for i, v := range s.Tags { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) - } - } - } +type DeleteDatasetInput struct { + _ struct{} `type:"structure"` - if invalidParams.Len() > 0 { - return invalidParams - } - return nil + // The Amazon Resource Name (ARN) of the dataset to delete. + // + // DatasetArn is a required field + DatasetArn *string `type:"string" required:"true"` } -// SetAlgorithmArn sets the AlgorithmArn field's value. -func (s *CreatePredictorInput) SetAlgorithmArn(v string) *CreatePredictorInput { - s.AlgorithmArn = &v - return s +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDatasetInput) String() string { + return awsutil.Prettify(s) } -// SetAutoMLOverrideStrategy sets the AutoMLOverrideStrategy field's value. -func (s *CreatePredictorInput) SetAutoMLOverrideStrategy(v string) *CreatePredictorInput { - s.AutoMLOverrideStrategy = &v - return s +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDatasetInput) GoString() string { + return s.String() } -// SetEncryptionConfig sets the EncryptionConfig field's value. -func (s *CreatePredictorInput) SetEncryptionConfig(v *EncryptionConfig) *CreatePredictorInput { - s.EncryptionConfig = v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteDatasetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteDatasetInput"} + if s.DatasetArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetArn")) + } -// SetEvaluationParameters sets the EvaluationParameters field's value. -func (s *CreatePredictorInput) SetEvaluationParameters(v *EvaluationParameters) *CreatePredictorInput { - s.EvaluationParameters = v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetFeaturizationConfig sets the FeaturizationConfig field's value. -func (s *CreatePredictorInput) SetFeaturizationConfig(v *FeaturizationConfig) *CreatePredictorInput { - s.FeaturizationConfig = v +// SetDatasetArn sets the DatasetArn field's value. +func (s *DeleteDatasetInput) SetDatasetArn(v string) *DeleteDatasetInput { + s.DatasetArn = &v return s } -// SetForecastHorizon sets the ForecastHorizon field's value. -func (s *CreatePredictorInput) SetForecastHorizon(v int64) *CreatePredictorInput { - s.ForecastHorizon = &v - return s +type DeleteDatasetOutput struct { + _ struct{} `type:"structure"` } -// SetForecastTypes sets the ForecastTypes field's value. -func (s *CreatePredictorInput) SetForecastTypes(v []*string) *CreatePredictorInput { - s.ForecastTypes = v - return s +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDatasetOutput) String() string { + return awsutil.Prettify(s) } -// SetHPOConfig sets the HPOConfig field's value. -func (s *CreatePredictorInput) SetHPOConfig(v *HyperParameterTuningJobConfig) *CreatePredictorInput { - s.HPOConfig = v - return s +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDatasetOutput) GoString() string { + return s.String() } -// SetInputDataConfig sets the InputDataConfig field's value. -func (s *CreatePredictorInput) SetInputDataConfig(v *InputDataConfig) *CreatePredictorInput { - s.InputDataConfig = v - return s -} +type DeleteExplainabilityExportInput struct { + _ struct{} `type:"structure"` -// SetOptimizationMetric sets the OptimizationMetric field's value. -func (s *CreatePredictorInput) SetOptimizationMetric(v string) *CreatePredictorInput { - s.OptimizationMetric = &v - return s + // The Amazon Resource Name (ARN) of the Explainability export to delete. + // + // ExplainabilityExportArn is a required field + ExplainabilityExportArn *string `type:"string" required:"true"` } -// SetPerformAutoML sets the PerformAutoML field's value. -func (s *CreatePredictorInput) SetPerformAutoML(v bool) *CreatePredictorInput { - s.PerformAutoML = &v - return s +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteExplainabilityExportInput) String() string { + return awsutil.Prettify(s) } -// SetPerformHPO sets the PerformHPO field's value. -func (s *CreatePredictorInput) SetPerformHPO(v bool) *CreatePredictorInput { - s.PerformHPO = &v - return s +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteExplainabilityExportInput) GoString() string { + return s.String() } -// SetPredictorName sets the PredictorName field's value. -func (s *CreatePredictorInput) SetPredictorName(v string) *CreatePredictorInput { - s.PredictorName = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteExplainabilityExportInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteExplainabilityExportInput"} + if s.ExplainabilityExportArn == nil { + invalidParams.Add(request.NewErrParamRequired("ExplainabilityExportArn")) + } -// SetTags sets the Tags field's value. -func (s *CreatePredictorInput) SetTags(v []*Tag) *CreatePredictorInput { - s.Tags = v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetTrainingParameters sets the TrainingParameters field's value. -func (s *CreatePredictorInput) SetTrainingParameters(v map[string]*string) *CreatePredictorInput { - s.TrainingParameters = v +// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value. +func (s *DeleteExplainabilityExportInput) SetExplainabilityExportArn(v string) *DeleteExplainabilityExportInput { + s.ExplainabilityExportArn = &v return s } -type CreatePredictorOutput struct { +type DeleteExplainabilityExportOutput struct { _ struct{} `type:"structure"` - - // The Amazon Resource Name (ARN) of the predictor. - PredictorArn *string `type:"string"` } // String returns the string representation. @@ -5413,7 +8117,7 @@ type CreatePredictorOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreatePredictorOutput) String() string { +func (s DeleteExplainabilityExportOutput) String() string { return awsutil.Prettify(s) } @@ -5422,27 +8126,17 @@ func (s CreatePredictorOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s CreatePredictorOutput) GoString() string { +func (s DeleteExplainabilityExportOutput) GoString() string { return s.String() } -// SetPredictorArn sets the PredictorArn field's value. -func (s *CreatePredictorOutput) SetPredictorArn(v string) *CreatePredictorOutput { - s.PredictorArn = &v - return s -} - -// The destination for an export job. Provide an S3 path, an AWS Identity and -// Access Management (IAM) role that allows Amazon Forecast to access the location, -// and an AWS Key Management Service (KMS) key (optional). -type DataDestination struct { +type DeleteExplainabilityInput struct { _ struct{} `type:"structure"` - // The path to an Amazon Simple Storage Service (Amazon S3) bucket along with - // the credentials to access the bucket. + // The Amazon Resource Name (ARN) of the Explainability resource to delete. // - // S3Config is a required field - S3Config *S3Config `type:"structure" required:"true"` + // ExplainabilityArn is a required field + ExplainabilityArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -5450,7 +8144,7 @@ type DataDestination struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DataDestination) String() string { +func (s DeleteExplainabilityInput) String() string { return awsutil.Prettify(s) } @@ -5459,20 +8153,15 @@ func (s DataDestination) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DataDestination) GoString() string { +func (s DeleteExplainabilityInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DataDestination) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DataDestination"} - if s.S3Config == nil { - invalidParams.Add(request.NewErrParamRequired("S3Config")) - } - if s.S3Config != nil { - if err := s.S3Config.Validate(); err != nil { - invalidParams.AddNested("S3Config", err.(request.ErrInvalidParams)) - } +func (s *DeleteExplainabilityInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteExplainabilityInput"} + if s.ExplainabilityArn == nil { + invalidParams.Add(request.NewErrParamRequired("ExplainabilityArn")) } if invalidParams.Len() > 0 { @@ -5481,24 +8170,41 @@ func (s *DataDestination) Validate() error { return nil } -// SetS3Config sets the S3Config field's value. -func (s *DataDestination) SetS3Config(v *S3Config) *DataDestination { - s.S3Config = v +// SetExplainabilityArn sets the ExplainabilityArn field's value. +func (s *DeleteExplainabilityInput) SetExplainabilityArn(v string) *DeleteExplainabilityInput { + s.ExplainabilityArn = &v return s } -// The source of your training data, an AWS Identity and Access Management (IAM) -// role that allows Amazon Forecast to access the data and, optionally, an AWS -// Key Management Service (KMS) key. This object is submitted in the CreateDatasetImportJob -// request. -type DataSource struct { +type DeleteExplainabilityOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteExplainabilityOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteExplainabilityOutput) GoString() string { + return s.String() +} + +type DeleteForecastExportJobInput struct { _ struct{} `type:"structure"` - // The path to the training data stored in an Amazon Simple Storage Service - // (Amazon S3) bucket along with the credentials to access the data. + // The Amazon Resource Name (ARN) of the forecast export job to delete. // - // S3Config is a required field - S3Config *S3Config `type:"structure" required:"true"` + // ForecastExportJobArn is a required field + ForecastExportJobArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -5506,7 +8212,7 @@ type DataSource struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DataSource) String() string { +func (s DeleteForecastExportJobInput) String() string { return awsutil.Prettify(s) } @@ -5515,20 +8221,15 @@ func (s DataSource) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DataSource) GoString() string { +func (s DeleteForecastExportJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DataSource) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DataSource"} - if s.S3Config == nil { - invalidParams.Add(request.NewErrParamRequired("S3Config")) - } - if s.S3Config != nil { - if err := s.S3Config.Validate(); err != nil { - invalidParams.AddNested("S3Config", err.(request.ErrInvalidParams)) - } +func (s *DeleteForecastExportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteForecastExportJobInput"} + if s.ForecastExportJobArn == nil { + invalidParams.Add(request.NewErrParamRequired("ForecastExportJobArn")) } if invalidParams.Len() > 0 { @@ -5537,31 +8238,14 @@ func (s *DataSource) Validate() error { return nil } -// SetS3Config sets the S3Config field's value. -func (s *DataSource) SetS3Config(v *S3Config) *DataSource { - s.S3Config = v +// SetForecastExportJobArn sets the ForecastExportJobArn field's value. +func (s *DeleteForecastExportJobInput) SetForecastExportJobArn(v string) *DeleteForecastExportJobInput { + s.ForecastExportJobArn = &v return s } -// Provides a summary of the dataset group properties used in the ListDatasetGroups -// operation. To get the complete set of properties, call the DescribeDatasetGroup -// operation, and provide the DatasetGroupArn. -type DatasetGroupSummary struct { +type DeleteForecastExportJobOutput struct { _ struct{} `type:"structure"` - - // When the dataset group was created. - CreationTime *time.Time `type:"timestamp"` - - // The Amazon Resource Name (ARN) of the dataset group. - DatasetGroupArn *string `type:"string"` - - // The name of the dataset group. - DatasetGroupName *string `min:"1" type:"string"` - - // When the dataset group was created or last updated from a call to the UpdateDatasetGroup - // operation. While the dataset group is being updated, LastModificationTime - // is the current time of the ListDatasetGroups call. - LastModificationTime *time.Time `type:"timestamp"` } // String returns the string representation. @@ -5569,7 +8253,7 @@ type DatasetGroupSummary struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DatasetGroupSummary) String() string { +func (s DeleteForecastExportJobOutput) String() string { return awsutil.Prettify(s) } @@ -5578,84 +8262,17 @@ func (s DatasetGroupSummary) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DatasetGroupSummary) GoString() string { +func (s DeleteForecastExportJobOutput) GoString() string { return s.String() } -// SetCreationTime sets the CreationTime field's value. -func (s *DatasetGroupSummary) SetCreationTime(v time.Time) *DatasetGroupSummary { - s.CreationTime = &v - return s -} - -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *DatasetGroupSummary) SetDatasetGroupArn(v string) *DatasetGroupSummary { - s.DatasetGroupArn = &v - return s -} - -// SetDatasetGroupName sets the DatasetGroupName field's value. -func (s *DatasetGroupSummary) SetDatasetGroupName(v string) *DatasetGroupSummary { - s.DatasetGroupName = &v - return s -} - -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *DatasetGroupSummary) SetLastModificationTime(v time.Time) *DatasetGroupSummary { - s.LastModificationTime = &v - return s -} - -// Provides a summary of the dataset import job properties used in the ListDatasetImportJobs -// operation. To get the complete set of properties, call the DescribeDatasetImportJob -// operation, and provide the DatasetImportJobArn. -type DatasetImportJobSummary struct { +type DeleteForecastInput struct { _ struct{} `type:"structure"` - // When the dataset import job was created. - CreationTime *time.Time `type:"timestamp"` - - // The location of the training data to import and an AWS Identity and Access - // Management (IAM) role that Amazon Forecast can assume to access the data. - // The training data must be stored in an Amazon S3 bucket. - // - // If encryption is used, DataSource includes an AWS Key Management Service - // (KMS) key. - DataSource *DataSource `type:"structure"` - - // The Amazon Resource Name (ARN) of the dataset import job. - DatasetImportJobArn *string `type:"string"` - - // The name of the dataset import job. - DatasetImportJobName *string `min:"1" type:"string"` - - // The last time the resource was modified. The timestamp depends on the status - // of the job: - // - // * CREATE_PENDING - The CreationTime. - // - // * CREATE_IN_PROGRESS - The current timestamp. - // - // * CREATE_STOPPING - The current timestamp. - // - // * CREATE_STOPPED - When the job stopped. - // - // * ACTIVE or CREATE_FAILED - When the job finished or failed. - LastModificationTime *time.Time `type:"timestamp"` - - // If an error occurred, an informational message about the error. - Message *string `type:"string"` - - // The status of the dataset import job. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // The Amazon Resource Name (ARN) of the forecast to delete. // - // * CREATE_STOPPING, CREATE_STOPPED - Status *string `type:"string"` + // ForecastArn is a required field + ForecastArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -5663,7 +8280,7 @@ type DatasetImportJobSummary struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DatasetImportJobSummary) String() string { +func (s DeleteForecastInput) String() string { return awsutil.Prettify(s) } @@ -5672,78 +8289,58 @@ func (s DatasetImportJobSummary) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DatasetImportJobSummary) GoString() string { +func (s DeleteForecastInput) GoString() string { return s.String() } -// SetCreationTime sets the CreationTime field's value. -func (s *DatasetImportJobSummary) SetCreationTime(v time.Time) *DatasetImportJobSummary { - s.CreationTime = &v - return s -} - -// SetDataSource sets the DataSource field's value. -func (s *DatasetImportJobSummary) SetDataSource(v *DataSource) *DatasetImportJobSummary { - s.DataSource = v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteForecastInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteForecastInput"} + if s.ForecastArn == nil { + invalidParams.Add(request.NewErrParamRequired("ForecastArn")) + } -// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. -func (s *DatasetImportJobSummary) SetDatasetImportJobArn(v string) *DatasetImportJobSummary { - s.DatasetImportJobArn = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetDatasetImportJobName sets the DatasetImportJobName field's value. -func (s *DatasetImportJobSummary) SetDatasetImportJobName(v string) *DatasetImportJobSummary { - s.DatasetImportJobName = &v +// SetForecastArn sets the ForecastArn field's value. +func (s *DeleteForecastInput) SetForecastArn(v string) *DeleteForecastInput { + s.ForecastArn = &v return s } -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *DatasetImportJobSummary) SetLastModificationTime(v time.Time) *DatasetImportJobSummary { - s.LastModificationTime = &v - return s +type DeleteForecastOutput struct { + _ struct{} `type:"structure"` } -// SetMessage sets the Message field's value. -func (s *DatasetImportJobSummary) SetMessage(v string) *DatasetImportJobSummary { - s.Message = &v - return s +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteForecastOutput) String() string { + return awsutil.Prettify(s) } -// SetStatus sets the Status field's value. -func (s *DatasetImportJobSummary) SetStatus(v string) *DatasetImportJobSummary { - s.Status = &v - return s +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteForecastOutput) GoString() string { + return s.String() } -// Provides a summary of the dataset properties used in the ListDatasets operation. -// To get the complete set of properties, call the DescribeDataset operation, -// and provide the DatasetArn. -type DatasetSummary struct { +type DeletePredictorBacktestExportJobInput struct { _ struct{} `type:"structure"` - // When the dataset was created. - CreationTime *time.Time `type:"timestamp"` - - // The Amazon Resource Name (ARN) of the dataset. - DatasetArn *string `type:"string"` - - // The name of the dataset. - DatasetName *string `min:"1" type:"string"` - - // The dataset type. - DatasetType *string `type:"string" enum:"DatasetType"` - - // The domain associated with the dataset. - Domain *string `type:"string" enum:"Domain"` - - // When you create a dataset, LastModificationTime is the same as CreationTime. - // While data is being imported to the dataset, LastModificationTime is the - // current time of the ListDatasets call. After a CreateDatasetImportJob operation - // has finished, LastModificationTime is when the import job completed or failed. - LastModificationTime *time.Time `type:"timestamp"` + // The Amazon Resource Name (ARN) of the predictor backtest export job to delete. + // + // PredictorBacktestExportJobArn is a required field + PredictorBacktestExportJobArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -5751,7 +8348,7 @@ type DatasetSummary struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DatasetSummary) String() string { +func (s DeletePredictorBacktestExportJobInput) String() string { return awsutil.Prettify(s) } @@ -5760,53 +8357,58 @@ func (s DatasetSummary) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DatasetSummary) GoString() string { +func (s DeletePredictorBacktestExportJobInput) GoString() string { return s.String() } -// SetCreationTime sets the CreationTime field's value. -func (s *DatasetSummary) SetCreationTime(v time.Time) *DatasetSummary { - s.CreationTime = &v - return s -} - -// SetDatasetArn sets the DatasetArn field's value. -func (s *DatasetSummary) SetDatasetArn(v string) *DatasetSummary { - s.DatasetArn = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeletePredictorBacktestExportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeletePredictorBacktestExportJobInput"} + if s.PredictorBacktestExportJobArn == nil { + invalidParams.Add(request.NewErrParamRequired("PredictorBacktestExportJobArn")) + } -// SetDatasetName sets the DatasetName field's value. -func (s *DatasetSummary) SetDatasetName(v string) *DatasetSummary { - s.DatasetName = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetDatasetType sets the DatasetType field's value. -func (s *DatasetSummary) SetDatasetType(v string) *DatasetSummary { - s.DatasetType = &v +// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value. +func (s *DeletePredictorBacktestExportJobInput) SetPredictorBacktestExportJobArn(v string) *DeletePredictorBacktestExportJobInput { + s.PredictorBacktestExportJobArn = &v return s } -// SetDomain sets the Domain field's value. -func (s *DatasetSummary) SetDomain(v string) *DatasetSummary { - s.Domain = &v - return s +type DeletePredictorBacktestExportJobOutput struct { + _ struct{} `type:"structure"` } -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *DatasetSummary) SetLastModificationTime(v time.Time) *DatasetSummary { - s.LastModificationTime = &v - return s +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePredictorBacktestExportJobOutput) String() string { + return awsutil.Prettify(s) } -type DeleteDatasetGroupInput struct { +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeletePredictorBacktestExportJobOutput) GoString() string { + return s.String() +} + +type DeletePredictorInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset group to delete. + // The Amazon Resource Name (ARN) of the predictor to delete. // - // DatasetGroupArn is a required field - DatasetGroupArn *string `type:"string" required:"true"` + // PredictorArn is a required field + PredictorArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -5814,7 +8416,7 @@ type DeleteDatasetGroupInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteDatasetGroupInput) String() string { +func (s DeletePredictorInput) String() string { return awsutil.Prettify(s) } @@ -5823,15 +8425,15 @@ func (s DeleteDatasetGroupInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteDatasetGroupInput) GoString() string { +func (s DeletePredictorInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteDatasetGroupInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteDatasetGroupInput"} - if s.DatasetGroupArn == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn")) +func (s *DeletePredictorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeletePredictorInput"} + if s.PredictorArn == nil { + invalidParams.Add(request.NewErrParamRequired("PredictorArn")) } if invalidParams.Len() > 0 { @@ -5840,13 +8442,13 @@ func (s *DeleteDatasetGroupInput) Validate() error { return nil } -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *DeleteDatasetGroupInput) SetDatasetGroupArn(v string) *DeleteDatasetGroupInput { - s.DatasetGroupArn = &v +// SetPredictorArn sets the PredictorArn field's value. +func (s *DeletePredictorInput) SetPredictorArn(v string) *DeletePredictorInput { + s.PredictorArn = &v return s } -type DeleteDatasetGroupOutput struct { +type DeletePredictorOutput struct { _ struct{} `type:"structure"` } @@ -5855,7 +8457,7 @@ type DeleteDatasetGroupOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteDatasetGroupOutput) String() string { +func (s DeletePredictorOutput) String() string { return awsutil.Prettify(s) } @@ -5864,17 +8466,18 @@ func (s DeleteDatasetGroupOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteDatasetGroupOutput) GoString() string { +func (s DeletePredictorOutput) GoString() string { return s.String() } -type DeleteDatasetImportJobInput struct { +type DeleteResourceTreeInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset import job to delete. + // The Amazon Resource Name (ARN) of the parent resource to delete. All child + // resources of the parent resource will also be deleted. // - // DatasetImportJobArn is a required field - DatasetImportJobArn *string `type:"string" required:"true"` + // ResourceArn is a required field + ResourceArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -5882,7 +8485,7 @@ type DeleteDatasetImportJobInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteDatasetImportJobInput) String() string { +func (s DeleteResourceTreeInput) String() string { return awsutil.Prettify(s) } @@ -5891,15 +8494,15 @@ func (s DeleteDatasetImportJobInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteDatasetImportJobInput) GoString() string { +func (s DeleteResourceTreeInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteDatasetImportJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteDatasetImportJobInput"} - if s.DatasetImportJobArn == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetImportJobArn")) +func (s *DeleteResourceTreeInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteResourceTreeInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) } if invalidParams.Len() > 0 { @@ -5908,13 +8511,13 @@ func (s *DeleteDatasetImportJobInput) Validate() error { return nil } -// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. -func (s *DeleteDatasetImportJobInput) SetDatasetImportJobArn(v string) *DeleteDatasetImportJobInput { - s.DatasetImportJobArn = &v +// SetResourceArn sets the ResourceArn field's value. +func (s *DeleteResourceTreeInput) SetResourceArn(v string) *DeleteResourceTreeInput { + s.ResourceArn = &v return s } -type DeleteDatasetImportJobOutput struct { +type DeleteResourceTreeOutput struct { _ struct{} `type:"structure"` } @@ -5923,7 +8526,7 @@ type DeleteDatasetImportJobOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteDatasetImportJobOutput) String() string { +func (s DeleteResourceTreeOutput) String() string { return awsutil.Prettify(s) } @@ -5932,17 +8535,17 @@ func (s DeleteDatasetImportJobOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteDatasetImportJobOutput) GoString() string { +func (s DeleteResourceTreeOutput) GoString() string { return s.String() } -type DeleteDatasetInput struct { +type DescribeAutoPredictorInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset to delete. + // The Amazon Resource Name (ARN) of the predictor. // - // DatasetArn is a required field - DatasetArn *string `type:"string" required:"true"` + // PredictorArn is a required field + PredictorArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -5950,7 +8553,7 @@ type DeleteDatasetInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteDatasetInput) String() string { +func (s DescribeAutoPredictorInput) String() string { return awsutil.Prettify(s) } @@ -5959,15 +8562,15 @@ func (s DeleteDatasetInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteDatasetInput) GoString() string { +func (s DescribeAutoPredictorInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteDatasetInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteDatasetInput"} - if s.DatasetArn == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetArn")) +func (s *DescribeAutoPredictorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeAutoPredictorInput"} + if s.PredictorArn == nil { + invalidParams.Add(request.NewErrParamRequired("PredictorArn")) } if invalidParams.Len() > 0 { @@ -5976,14 +8579,91 @@ func (s *DeleteDatasetInput) Validate() error { return nil } -// SetDatasetArn sets the DatasetArn field's value. -func (s *DeleteDatasetInput) SetDatasetArn(v string) *DeleteDatasetInput { - s.DatasetArn = &v +// SetPredictorArn sets the PredictorArn field's value. +func (s *DescribeAutoPredictorInput) SetPredictorArn(v string) *DescribeAutoPredictorInput { + s.PredictorArn = &v return s } -type DeleteDatasetOutput struct { +type DescribeAutoPredictorOutput struct { _ struct{} `type:"structure"` + + // The timestamp of the CreateAutoPredictor request. + CreationTime *time.Time `type:"timestamp"` + + // The data configuration for your dataset group and any additional datasets. + DataConfig *DataConfig `type:"structure"` + + // An array of the ARNs of the dataset import jobs used to import training data + // for the predictor. + DatasetImportJobArns []*string `type:"list"` + + // An AWS Key Management Service (KMS) key and an AWS Identity and Access Management + // (IAM) role that Amazon Forecast can assume to access the key. You can specify + // this optional object in the CreateDataset and CreatePredictor requests. + EncryptionConfig *EncryptionConfig `type:"structure"` + + // The estimated time remaining in minutes for the predictor training job to + // complete. + EstimatedTimeRemainingInMinutes *int64 `type:"long"` + + ExplainabilityInfo *ExplainabilityInfo `type:"structure"` + + // The frequency of predictions in a forecast. + // + // Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min + // (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and + // 1min (1 minute). For example, "Y" indicates every year and "5min" indicates + // every five minutes. + ForecastFrequency *string `min:"1" type:"string"` + + // The number of time-steps that the model predicts. The forecast horizon is + // also called the prediction length. + ForecastHorizon *int64 `type:"integer"` + + // The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"]. + ForecastTypes []*string `min:"1" type:"list"` + + // The last time the resource was modified. The timestamp depends on the status + // of the job: + // + // * CREATE_PENDING - The CreationTime. + // + // * CREATE_IN_PROGRESS - The current timestamp. + // + // * CREATE_STOPPING - The current timestamp. + // + // * CREATE_STOPPED - When the job stopped. + // + // * ACTIVE or CREATE_FAILED - When the job finished or failed. + LastModificationTime *time.Time `type:"timestamp"` + + // In the event of an error, a message detailing the cause of the error. + Message *string `type:"string"` + + // The accuracy metric used to optimize the predictor. + OptimizationMetric *string `type:"string" enum:"OptimizationMetric"` + + // The Amazon Resource Name (ARN) of the predictor + PredictorArn *string `type:"string"` + + // The name of the predictor. + PredictorName *string `min:"1" type:"string"` + + // The ARN and state of the reference predictor. This parameter is only valid + // for retrained or upgraded predictors. + ReferencePredictorSummary *ReferencePredictorSummary `type:"structure"` + + // The status of the predictor. States include: + // + // * ACTIVE + // + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * CREATE_STOPPING, CREATE_STOPPED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + Status *string `type:"string"` } // String returns the string representation. @@ -5991,7 +8671,7 @@ type DeleteDatasetOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteDatasetOutput) String() string { +func (s DescribeAutoPredictorOutput) String() string { return awsutil.Prettify(s) } @@ -6000,17 +8680,113 @@ func (s DeleteDatasetOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteDatasetOutput) GoString() string { +func (s DescribeAutoPredictorOutput) GoString() string { return s.String() } -type DeleteForecastExportJobInput struct { +// SetCreationTime sets the CreationTime field's value. +func (s *DescribeAutoPredictorOutput) SetCreationTime(v time.Time) *DescribeAutoPredictorOutput { + s.CreationTime = &v + return s +} + +// SetDataConfig sets the DataConfig field's value. +func (s *DescribeAutoPredictorOutput) SetDataConfig(v *DataConfig) *DescribeAutoPredictorOutput { + s.DataConfig = v + return s +} + +// SetDatasetImportJobArns sets the DatasetImportJobArns field's value. +func (s *DescribeAutoPredictorOutput) SetDatasetImportJobArns(v []*string) *DescribeAutoPredictorOutput { + s.DatasetImportJobArns = v + return s +} + +// SetEncryptionConfig sets the EncryptionConfig field's value. +func (s *DescribeAutoPredictorOutput) SetEncryptionConfig(v *EncryptionConfig) *DescribeAutoPredictorOutput { + s.EncryptionConfig = v + return s +} + +// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value. +func (s *DescribeAutoPredictorOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeAutoPredictorOutput { + s.EstimatedTimeRemainingInMinutes = &v + return s +} + +// SetExplainabilityInfo sets the ExplainabilityInfo field's value. +func (s *DescribeAutoPredictorOutput) SetExplainabilityInfo(v *ExplainabilityInfo) *DescribeAutoPredictorOutput { + s.ExplainabilityInfo = v + return s +} + +// SetForecastFrequency sets the ForecastFrequency field's value. +func (s *DescribeAutoPredictorOutput) SetForecastFrequency(v string) *DescribeAutoPredictorOutput { + s.ForecastFrequency = &v + return s +} + +// SetForecastHorizon sets the ForecastHorizon field's value. +func (s *DescribeAutoPredictorOutput) SetForecastHorizon(v int64) *DescribeAutoPredictorOutput { + s.ForecastHorizon = &v + return s +} + +// SetForecastTypes sets the ForecastTypes field's value. +func (s *DescribeAutoPredictorOutput) SetForecastTypes(v []*string) *DescribeAutoPredictorOutput { + s.ForecastTypes = v + return s +} + +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DescribeAutoPredictorOutput) SetLastModificationTime(v time.Time) *DescribeAutoPredictorOutput { + s.LastModificationTime = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *DescribeAutoPredictorOutput) SetMessage(v string) *DescribeAutoPredictorOutput { + s.Message = &v + return s +} + +// SetOptimizationMetric sets the OptimizationMetric field's value. +func (s *DescribeAutoPredictorOutput) SetOptimizationMetric(v string) *DescribeAutoPredictorOutput { + s.OptimizationMetric = &v + return s +} + +// SetPredictorArn sets the PredictorArn field's value. +func (s *DescribeAutoPredictorOutput) SetPredictorArn(v string) *DescribeAutoPredictorOutput { + s.PredictorArn = &v + return s +} + +// SetPredictorName sets the PredictorName field's value. +func (s *DescribeAutoPredictorOutput) SetPredictorName(v string) *DescribeAutoPredictorOutput { + s.PredictorName = &v + return s +} + +// SetReferencePredictorSummary sets the ReferencePredictorSummary field's value. +func (s *DescribeAutoPredictorOutput) SetReferencePredictorSummary(v *ReferencePredictorSummary) *DescribeAutoPredictorOutput { + s.ReferencePredictorSummary = v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribeAutoPredictorOutput) SetStatus(v string) *DescribeAutoPredictorOutput { + s.Status = &v + return s +} + +type DescribeDatasetGroupInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the forecast export job to delete. + // The Amazon Resource Name (ARN) of the dataset group. // - // ForecastExportJobArn is a required field - ForecastExportJobArn *string `type:"string" required:"true"` + // DatasetGroupArn is a required field + DatasetGroupArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -6018,7 +8794,7 @@ type DeleteForecastExportJobInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteForecastExportJobInput) String() string { +func (s DescribeDatasetGroupInput) String() string { return awsutil.Prettify(s) } @@ -6027,15 +8803,15 @@ func (s DeleteForecastExportJobInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteForecastExportJobInput) GoString() string { +func (s DescribeDatasetGroupInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteForecastExportJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteForecastExportJobInput"} - if s.ForecastExportJobArn == nil { - invalidParams.Add(request.NewErrParamRequired("ForecastExportJobArn")) +func (s *DescribeDatasetGroupInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDatasetGroupInput"} + if s.DatasetGroupArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn")) } if invalidParams.Len() > 0 { @@ -6044,41 +8820,51 @@ func (s *DeleteForecastExportJobInput) Validate() error { return nil } -// SetForecastExportJobArn sets the ForecastExportJobArn field's value. -func (s *DeleteForecastExportJobInput) SetForecastExportJobArn(v string) *DeleteForecastExportJobInput { - s.ForecastExportJobArn = &v +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *DescribeDatasetGroupInput) SetDatasetGroupArn(v string) *DescribeDatasetGroupInput { + s.DatasetGroupArn = &v return s } -type DeleteForecastExportJobOutput struct { +type DescribeDatasetGroupOutput struct { _ struct{} `type:"structure"` -} -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DeleteForecastExportJobOutput) String() string { - return awsutil.Prettify(s) -} + // When the dataset group was created. + CreationTime *time.Time `type:"timestamp"` -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DeleteForecastExportJobOutput) GoString() string { - return s.String() -} + // An array of Amazon Resource Names (ARNs) of the datasets contained in the + // dataset group. + DatasetArns []*string `type:"list"` -type DeleteForecastInput struct { - _ struct{} `type:"structure"` + // The ARN of the dataset group. + DatasetGroupArn *string `type:"string"` - // The Amazon Resource Name (ARN) of the forecast to delete. + // The name of the dataset group. + DatasetGroupName *string `min:"1" type:"string"` + + // The domain associated with the dataset group. + Domain *string `type:"string" enum:"Domain"` + + // When the dataset group was created or last updated from a call to the UpdateDatasetGroup + // operation. While the dataset group is being updated, LastModificationTime + // is the current time of the DescribeDatasetGroup call. + LastModificationTime *time.Time `type:"timestamp"` + + // The status of the dataset group. States include: // - // ForecastArn is a required field - ForecastArn *string `type:"string" required:"true"` + // * ACTIVE + // + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // + // * UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED + // + // The UPDATE states apply when you call the UpdateDatasetGroup operation. + // + // The Status of the dataset group must be ACTIVE before you can use the dataset + // group to create a predictor. + Status *string `type:"string"` } // String returns the string representation. @@ -6086,7 +8872,7 @@ type DeleteForecastInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteForecastInput) String() string { +func (s DescribeDatasetGroupOutput) String() string { return awsutil.Prettify(s) } @@ -6095,58 +8881,59 @@ func (s DeleteForecastInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeleteForecastInput) GoString() string { +func (s DescribeDatasetGroupOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteForecastInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteForecastInput"} - if s.ForecastArn == nil { - invalidParams.Add(request.NewErrParamRequired("ForecastArn")) - } +// SetCreationTime sets the CreationTime field's value. +func (s *DescribeDatasetGroupOutput) SetCreationTime(v time.Time) *DescribeDatasetGroupOutput { + s.CreationTime = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetDatasetArns sets the DatasetArns field's value. +func (s *DescribeDatasetGroupOutput) SetDatasetArns(v []*string) *DescribeDatasetGroupOutput { + s.DatasetArns = v + return s } -// SetForecastArn sets the ForecastArn field's value. -func (s *DeleteForecastInput) SetForecastArn(v string) *DeleteForecastInput { - s.ForecastArn = &v +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *DescribeDatasetGroupOutput) SetDatasetGroupArn(v string) *DescribeDatasetGroupOutput { + s.DatasetGroupArn = &v return s } -type DeleteForecastOutput struct { - _ struct{} `type:"structure"` +// SetDatasetGroupName sets the DatasetGroupName field's value. +func (s *DescribeDatasetGroupOutput) SetDatasetGroupName(v string) *DescribeDatasetGroupOutput { + s.DatasetGroupName = &v + return s } -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DeleteForecastOutput) String() string { - return awsutil.Prettify(s) +// SetDomain sets the Domain field's value. +func (s *DescribeDatasetGroupOutput) SetDomain(v string) *DescribeDatasetGroupOutput { + s.Domain = &v + return s } -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DeleteForecastOutput) GoString() string { - return s.String() +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DescribeDatasetGroupOutput) SetLastModificationTime(v time.Time) *DescribeDatasetGroupOutput { + s.LastModificationTime = &v + return s } -type DeletePredictorBacktestExportJobInput struct { +// SetStatus sets the Status field's value. +func (s *DescribeDatasetGroupOutput) SetStatus(v string) *DescribeDatasetGroupOutput { + s.Status = &v + return s +} + +type DescribeDatasetImportJobInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the predictor backtest export job to delete. + // The Amazon Resource Name (ARN) of the dataset import job. // - // PredictorBacktestExportJobArn is a required field - PredictorBacktestExportJobArn *string `type:"string" required:"true"` + // DatasetImportJobArn is a required field + DatasetImportJobArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -6154,7 +8941,7 @@ type DeletePredictorBacktestExportJobInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeletePredictorBacktestExportJobInput) String() string { +func (s DescribeDatasetImportJobInput) String() string { return awsutil.Prettify(s) } @@ -6163,15 +8950,15 @@ func (s DeletePredictorBacktestExportJobInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeletePredictorBacktestExportJobInput) GoString() string { +func (s DescribeDatasetImportJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeletePredictorBacktestExportJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeletePredictorBacktestExportJobInput"} - if s.PredictorBacktestExportJobArn == nil { - invalidParams.Add(request.NewErrParamRequired("PredictorBacktestExportJobArn")) +func (s *DescribeDatasetImportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDatasetImportJobInput"} + if s.DatasetImportJobArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetImportJobArn")) } if invalidParams.Len() > 0 { @@ -6180,41 +8967,90 @@ func (s *DeletePredictorBacktestExportJobInput) Validate() error { return nil } -// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value. -func (s *DeletePredictorBacktestExportJobInput) SetPredictorBacktestExportJobArn(v string) *DeletePredictorBacktestExportJobInput { - s.PredictorBacktestExportJobArn = &v +// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. +func (s *DescribeDatasetImportJobInput) SetDatasetImportJobArn(v string) *DescribeDatasetImportJobInput { + s.DatasetImportJobArn = &v return s } -type DeletePredictorBacktestExportJobOutput struct { +type DescribeDatasetImportJobOutput struct { _ struct{} `type:"structure"` -} -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DeletePredictorBacktestExportJobOutput) String() string { - return awsutil.Prettify(s) -} + // When the dataset import job was created. + CreationTime *time.Time `type:"timestamp"` -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DeletePredictorBacktestExportJobOutput) GoString() string { - return s.String() -} + // The size of the dataset in gigabytes (GB) after the import job has finished. + DataSize *float64 `type:"double"` -type DeletePredictorInput struct { - _ struct{} `type:"structure"` + // The location of the training data to import and an AWS Identity and Access + // Management (IAM) role that Amazon Forecast can assume to access the data. + // + // If encryption is used, DataSource includes an AWS Key Management Service + // (KMS) key. + DataSource *DataSource `type:"structure"` + + // The Amazon Resource Name (ARN) of the dataset that the training data was + // imported to. + DatasetArn *string `type:"string"` + + // The ARN of the dataset import job. + DatasetImportJobArn *string `type:"string"` + + // The name of the dataset import job. + DatasetImportJobName *string `min:"1" type:"string"` + + // The estimated time remaining in minutes for the dataset import job to complete. + EstimatedTimeRemainingInMinutes *int64 `type:"long"` + + // Statistical information about each field in the input data. + FieldStatistics map[string]*Statistics `type:"map"` + + // The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE". + GeolocationFormat *string `type:"string"` + + // The last time the resource was modified. The timestamp depends on the status + // of the job: + // + // * CREATE_PENDING - The CreationTime. + // + // * CREATE_IN_PROGRESS - The current timestamp. + // + // * CREATE_STOPPING - The current timestamp. + // + // * CREATE_STOPPED - When the job stopped. + // + // * ACTIVE or CREATE_FAILED - When the job finished or failed. + LastModificationTime *time.Time `type:"timestamp"` + + // If an error occurred, an informational message about the error. + Message *string `type:"string"` + + // The status of the dataset import job. States include: + // + // * ACTIVE + // + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // + // * CREATE_STOPPING, CREATE_STOPPED + Status *string `type:"string"` + + // The single time zone applied to every item in the dataset + TimeZone *string `type:"string"` + + // The format of timestamps in the dataset. The format that you specify depends + // on the DataFrequency specified when the dataset was created. The following + // formats are supported + // + // * "yyyy-MM-dd" For the following data frequencies: Y, M, W, and D + // + // * "yyyy-MM-dd HH:mm:ss" For the following data frequencies: H, 30min, + // 15min, and 1min; and optionally, for: Y, M, W, and D + TimestampFormat *string `type:"string"` - // The Amazon Resource Name (ARN) of the predictor to delete. - // - // PredictorArn is a required field - PredictorArn *string `type:"string" required:"true"` + // Whether TimeZone is automatically derived from the geolocation attribute. + UseGeolocationForTimeZone *bool `type:"boolean"` } // String returns the string representation. @@ -6222,7 +9058,7 @@ type DeletePredictorInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeletePredictorInput) String() string { +func (s DescribeDatasetImportJobOutput) String() string { return awsutil.Prettify(s) } @@ -6231,127 +9067,107 @@ func (s DeletePredictorInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DeletePredictorInput) GoString() string { +func (s DescribeDatasetImportJobOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DeletePredictorInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeletePredictorInput"} - if s.PredictorArn == nil { - invalidParams.Add(request.NewErrParamRequired("PredictorArn")) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetCreationTime sets the CreationTime field's value. +func (s *DescribeDatasetImportJobOutput) SetCreationTime(v time.Time) *DescribeDatasetImportJobOutput { + s.CreationTime = &v + return s } -// SetPredictorArn sets the PredictorArn field's value. -func (s *DeletePredictorInput) SetPredictorArn(v string) *DeletePredictorInput { - s.PredictorArn = &v +// SetDataSize sets the DataSize field's value. +func (s *DescribeDatasetImportJobOutput) SetDataSize(v float64) *DescribeDatasetImportJobOutput { + s.DataSize = &v return s } -type DeletePredictorOutput struct { - _ struct{} `type:"structure"` +// SetDataSource sets the DataSource field's value. +func (s *DescribeDatasetImportJobOutput) SetDataSource(v *DataSource) *DescribeDatasetImportJobOutput { + s.DataSource = v + return s } -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DeletePredictorOutput) String() string { - return awsutil.Prettify(s) +// SetDatasetArn sets the DatasetArn field's value. +func (s *DescribeDatasetImportJobOutput) SetDatasetArn(v string) *DescribeDatasetImportJobOutput { + s.DatasetArn = &v + return s } -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DeletePredictorOutput) GoString() string { - return s.String() +// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. +func (s *DescribeDatasetImportJobOutput) SetDatasetImportJobArn(v string) *DescribeDatasetImportJobOutput { + s.DatasetImportJobArn = &v + return s } -type DeleteResourceTreeInput struct { - _ struct{} `type:"structure"` +// SetDatasetImportJobName sets the DatasetImportJobName field's value. +func (s *DescribeDatasetImportJobOutput) SetDatasetImportJobName(v string) *DescribeDatasetImportJobOutput { + s.DatasetImportJobName = &v + return s +} - // The Amazon Resource Name (ARN) of the parent resource to delete. All child - // resources of the parent resource will also be deleted. - // - // ResourceArn is a required field - ResourceArn *string `type:"string" required:"true"` +// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value. +func (s *DescribeDatasetImportJobOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeDatasetImportJobOutput { + s.EstimatedTimeRemainingInMinutes = &v + return s } -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DeleteResourceTreeInput) String() string { - return awsutil.Prettify(s) +// SetFieldStatistics sets the FieldStatistics field's value. +func (s *DescribeDatasetImportJobOutput) SetFieldStatistics(v map[string]*Statistics) *DescribeDatasetImportJobOutput { + s.FieldStatistics = v + return s } -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DeleteResourceTreeInput) GoString() string { - return s.String() +// SetGeolocationFormat sets the GeolocationFormat field's value. +func (s *DescribeDatasetImportJobOutput) SetGeolocationFormat(v string) *DescribeDatasetImportJobOutput { + s.GeolocationFormat = &v + return s } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteResourceTreeInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteResourceTreeInput"} - if s.ResourceArn == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceArn")) - } +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DescribeDatasetImportJobOutput) SetLastModificationTime(v time.Time) *DescribeDatasetImportJobOutput { + s.LastModificationTime = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetMessage sets the Message field's value. +func (s *DescribeDatasetImportJobOutput) SetMessage(v string) *DescribeDatasetImportJobOutput { + s.Message = &v + return s } -// SetResourceArn sets the ResourceArn field's value. -func (s *DeleteResourceTreeInput) SetResourceArn(v string) *DeleteResourceTreeInput { - s.ResourceArn = &v +// SetStatus sets the Status field's value. +func (s *DescribeDatasetImportJobOutput) SetStatus(v string) *DescribeDatasetImportJobOutput { + s.Status = &v return s } -type DeleteResourceTreeOutput struct { - _ struct{} `type:"structure"` +// SetTimeZone sets the TimeZone field's value. +func (s *DescribeDatasetImportJobOutput) SetTimeZone(v string) *DescribeDatasetImportJobOutput { + s.TimeZone = &v + return s } -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DeleteResourceTreeOutput) String() string { - return awsutil.Prettify(s) +// SetTimestampFormat sets the TimestampFormat field's value. +func (s *DescribeDatasetImportJobOutput) SetTimestampFormat(v string) *DescribeDatasetImportJobOutput { + s.TimestampFormat = &v + return s } -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DeleteResourceTreeOutput) GoString() string { - return s.String() +// SetUseGeolocationForTimeZone sets the UseGeolocationForTimeZone field's value. +func (s *DescribeDatasetImportJobOutput) SetUseGeolocationForTimeZone(v bool) *DescribeDatasetImportJobOutput { + s.UseGeolocationForTimeZone = &v + return s } -type DescribeDatasetGroupInput struct { +type DescribeDatasetInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset group. + // The Amazon Resource Name (ARN) of the dataset. // - // DatasetGroupArn is a required field - DatasetGroupArn *string `type:"string" required:"true"` + // DatasetArn is a required field + DatasetArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -6359,7 +9175,7 @@ type DescribeDatasetGroupInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeDatasetGroupInput) String() string { +func (s DescribeDatasetInput) String() string { return awsutil.Prettify(s) } @@ -6368,15 +9184,15 @@ func (s DescribeDatasetGroupInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeDatasetGroupInput) GoString() string { +func (s DescribeDatasetInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeDatasetGroupInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeDatasetGroupInput"} - if s.DatasetGroupArn == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn")) +func (s *DescribeDatasetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDatasetInput"} + if s.DatasetArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetArn")) } if invalidParams.Len() > 0 { @@ -6385,37 +9201,54 @@ func (s *DescribeDatasetGroupInput) Validate() error { return nil } -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *DescribeDatasetGroupInput) SetDatasetGroupArn(v string) *DescribeDatasetGroupInput { - s.DatasetGroupArn = &v +// SetDatasetArn sets the DatasetArn field's value. +func (s *DescribeDatasetInput) SetDatasetArn(v string) *DescribeDatasetInput { + s.DatasetArn = &v return s } -type DescribeDatasetGroupOutput struct { +type DescribeDatasetOutput struct { _ struct{} `type:"structure"` - // When the dataset group was created. + // When the dataset was created. CreationTime *time.Time `type:"timestamp"` - // An array of Amazon Resource Names (ARNs) of the datasets contained in the - // dataset group. - DatasetArns []*string `type:"list"` + // The frequency of data collection. + // + // Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min + // (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and + // 1min (1 minute). For example, "M" indicates every month and "30min" indicates + // every 30 minutes. + DataFrequency *string `min:"1" type:"string"` - // The ARN of the dataset group. - DatasetGroupArn *string `type:"string"` + // The Amazon Resource Name (ARN) of the dataset. + DatasetArn *string `type:"string"` - // The name of the dataset group. - DatasetGroupName *string `min:"1" type:"string"` + // The name of the dataset. + DatasetName *string `min:"1" type:"string"` - // The domain associated with the dataset group. + // The dataset type. + DatasetType *string `type:"string" enum:"DatasetType"` + + // The domain associated with the dataset. Domain *string `type:"string" enum:"Domain"` - // When the dataset group was created or last updated from a call to the UpdateDatasetGroup - // operation. While the dataset group is being updated, LastModificationTime - // is the current time of the DescribeDatasetGroup call. + // The AWS Key Management Service (KMS) key and the AWS Identity and Access + // Management (IAM) role that Amazon Forecast can assume to access the key. + EncryptionConfig *EncryptionConfig `type:"structure"` + + // When you create a dataset, LastModificationTime is the same as CreationTime. + // While data is being imported to the dataset, LastModificationTime is the + // current time of the DescribeDataset call. After a CreateDatasetImportJob + // operation has finished, LastModificationTime is when the import job completed + // or failed. LastModificationTime *time.Time `type:"timestamp"` - // The status of the dataset group. States include: + // An array of SchemaAttribute objects that specify the dataset fields. Each + // SchemaAttribute specifies the name and data type of a field. + Schema *Schema `type:"structure"` + + // The status of the dataset. States include: // // * ACTIVE // @@ -6425,10 +9258,12 @@ type DescribeDatasetGroupOutput struct { // // * UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED // - // The UPDATE states apply when you call the UpdateDatasetGroup operation. + // The UPDATE states apply while data is imported to the dataset from a call + // to the CreateDatasetImportJob operation and reflect the status of the dataset + // import job. For example, when the import job status is CREATE_IN_PROGRESS, + // the status of the dataset is UPDATE_IN_PROGRESS. // - // The Status of the dataset group must be ACTIVE before you can use the dataset - // group to create a predictor. + // The Status of the dataset must be ACTIVE before you can import training data. Status *string `type:"string"` } @@ -6437,7 +9272,7 @@ type DescribeDatasetGroupOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeDatasetGroupOutput) String() string { +func (s DescribeDatasetOutput) String() string { return awsutil.Prettify(s) } @@ -6446,59 +9281,77 @@ func (s DescribeDatasetGroupOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeDatasetGroupOutput) GoString() string { +func (s DescribeDatasetOutput) GoString() string { return s.String() } // SetCreationTime sets the CreationTime field's value. -func (s *DescribeDatasetGroupOutput) SetCreationTime(v time.Time) *DescribeDatasetGroupOutput { +func (s *DescribeDatasetOutput) SetCreationTime(v time.Time) *DescribeDatasetOutput { s.CreationTime = &v return s } -// SetDatasetArns sets the DatasetArns field's value. -func (s *DescribeDatasetGroupOutput) SetDatasetArns(v []*string) *DescribeDatasetGroupOutput { - s.DatasetArns = v +// SetDataFrequency sets the DataFrequency field's value. +func (s *DescribeDatasetOutput) SetDataFrequency(v string) *DescribeDatasetOutput { + s.DataFrequency = &v return s } -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *DescribeDatasetGroupOutput) SetDatasetGroupArn(v string) *DescribeDatasetGroupOutput { - s.DatasetGroupArn = &v +// SetDatasetArn sets the DatasetArn field's value. +func (s *DescribeDatasetOutput) SetDatasetArn(v string) *DescribeDatasetOutput { + s.DatasetArn = &v return s } -// SetDatasetGroupName sets the DatasetGroupName field's value. -func (s *DescribeDatasetGroupOutput) SetDatasetGroupName(v string) *DescribeDatasetGroupOutput { - s.DatasetGroupName = &v +// SetDatasetName sets the DatasetName field's value. +func (s *DescribeDatasetOutput) SetDatasetName(v string) *DescribeDatasetOutput { + s.DatasetName = &v + return s +} + +// SetDatasetType sets the DatasetType field's value. +func (s *DescribeDatasetOutput) SetDatasetType(v string) *DescribeDatasetOutput { + s.DatasetType = &v return s } // SetDomain sets the Domain field's value. -func (s *DescribeDatasetGroupOutput) SetDomain(v string) *DescribeDatasetGroupOutput { +func (s *DescribeDatasetOutput) SetDomain(v string) *DescribeDatasetOutput { s.Domain = &v return s } +// SetEncryptionConfig sets the EncryptionConfig field's value. +func (s *DescribeDatasetOutput) SetEncryptionConfig(v *EncryptionConfig) *DescribeDatasetOutput { + s.EncryptionConfig = v + return s +} + // SetLastModificationTime sets the LastModificationTime field's value. -func (s *DescribeDatasetGroupOutput) SetLastModificationTime(v time.Time) *DescribeDatasetGroupOutput { +func (s *DescribeDatasetOutput) SetLastModificationTime(v time.Time) *DescribeDatasetOutput { s.LastModificationTime = &v return s } +// SetSchema sets the Schema field's value. +func (s *DescribeDatasetOutput) SetSchema(v *Schema) *DescribeDatasetOutput { + s.Schema = v + return s +} + // SetStatus sets the Status field's value. -func (s *DescribeDatasetGroupOutput) SetStatus(v string) *DescribeDatasetGroupOutput { +func (s *DescribeDatasetOutput) SetStatus(v string) *DescribeDatasetOutput { s.Status = &v return s } -type DescribeDatasetImportJobInput struct { +type DescribeExplainabilityExportInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset import job. + // The Amazon Resource Name (ARN) of the Explainability export. // - // DatasetImportJobArn is a required field - DatasetImportJobArn *string `type:"string" required:"true"` + // ExplainabilityExportArn is a required field + ExplainabilityExportArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -6506,7 +9359,7 @@ type DescribeDatasetImportJobInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeDatasetImportJobInput) String() string { +func (s DescribeExplainabilityExportInput) String() string { return awsutil.Prettify(s) } @@ -6515,15 +9368,15 @@ func (s DescribeDatasetImportJobInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeDatasetImportJobInput) GoString() string { +func (s DescribeExplainabilityExportInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeDatasetImportJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeDatasetImportJobInput"} - if s.DatasetImportJobArn == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetImportJobArn")) +func (s *DescribeExplainabilityExportInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeExplainabilityExportInput"} + if s.ExplainabilityExportArn == nil { + invalidParams.Add(request.NewErrParamRequired("ExplainabilityExportArn")) } if invalidParams.Len() > 0 { @@ -6532,46 +9385,31 @@ func (s *DescribeDatasetImportJobInput) Validate() error { return nil } -// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. -func (s *DescribeDatasetImportJobInput) SetDatasetImportJobArn(v string) *DescribeDatasetImportJobInput { - s.DatasetImportJobArn = &v +// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value. +func (s *DescribeExplainabilityExportInput) SetExplainabilityExportArn(v string) *DescribeExplainabilityExportInput { + s.ExplainabilityExportArn = &v return s } -type DescribeDatasetImportJobOutput struct { +type DescribeExplainabilityExportOutput struct { _ struct{} `type:"structure"` - // When the dataset import job was created. + // When the Explainability export was created. CreationTime *time.Time `type:"timestamp"` - // The size of the dataset in gigabytes (GB) after the import job has finished. - DataSize *float64 `type:"double"` - - // The location of the training data to import and an AWS Identity and Access - // Management (IAM) role that Amazon Forecast can assume to access the data. - // - // If encryption is used, DataSource includes an AWS Key Management Service - // (KMS) key. - DataSource *DataSource `type:"structure"` - - // The Amazon Resource Name (ARN) of the dataset that the training data was - // imported to. - DatasetArn *string `type:"string"` - - // The ARN of the dataset import job. - DatasetImportJobArn *string `type:"string"` - - // The name of the dataset import job. - DatasetImportJobName *string `min:"1" type:"string"` + // The destination for an export job. Provide an S3 path, an AWS Identity and + // Access Management (IAM) role that allows Amazon Forecast to access the location, + // and an AWS Key Management Service (KMS) key (optional). + Destination *DataDestination `type:"structure"` - // The estimated time remaining in minutes for the dataset import job to complete. - EstimatedTimeRemainingInMinutes *int64 `type:"long"` + // The Amazon Resource Name (ARN) of the Explainability. + ExplainabilityArn *string `type:"string"` - // Statistical information about each field in the input data. - FieldStatistics map[string]*Statistics `type:"map"` + // The Amazon Resource Name (ARN) of the Explainability export. + ExplainabilityExportArn *string `type:"string"` - // The format of the geolocation attribute. Valid Values:"LAT_LONG" and "CC_POSTALCODE". - GeolocationFormat *string `type:"string"` + // The name of the Explainability export. + ExplainabilityExportName *string `min:"1" type:"string"` // The last time the resource was modified. The timestamp depends on the status // of the job: @@ -6587,35 +9425,19 @@ type DescribeDatasetImportJobOutput struct { // * ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time `type:"timestamp"` - // If an error occurred, an informational message about the error. + // Information about any errors that occurred during the export. Message *string `type:"string"` - // The status of the dataset import job. States include: + // The status of the Explainability export. States include: // // * ACTIVE // // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - // // * CREATE_STOPPING, CREATE_STOPPED - Status *string `type:"string"` - - // The single time zone applied to every item in the dataset - TimeZone *string `type:"string"` - - // The format of timestamps in the dataset. The format that you specify depends - // on the DataFrequency specified when the dataset was created. The following - // formats are supported // - // * "yyyy-MM-dd" For the following data frequencies: Y, M, W, and D - // - // * "yyyy-MM-dd HH:mm:ss" For the following data frequencies: H, 30min, - // 15min, and 1min; and optionally, for: Y, M, W, and D - TimestampFormat *string `type:"string"` - - // Whether TimeZone is automatically derived from the geolocation attribute. - UseGeolocationForTimeZone *bool `type:"boolean"` + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + Status *string `type:"string"` } // String returns the string representation. @@ -6623,7 +9445,7 @@ type DescribeDatasetImportJobOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeDatasetImportJobOutput) String() string { +func (s DescribeExplainabilityExportOutput) String() string { return awsutil.Prettify(s) } @@ -6632,107 +9454,65 @@ func (s DescribeDatasetImportJobOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeDatasetImportJobOutput) GoString() string { +func (s DescribeExplainabilityExportOutput) GoString() string { return s.String() } // SetCreationTime sets the CreationTime field's value. -func (s *DescribeDatasetImportJobOutput) SetCreationTime(v time.Time) *DescribeDatasetImportJobOutput { +func (s *DescribeExplainabilityExportOutput) SetCreationTime(v time.Time) *DescribeExplainabilityExportOutput { s.CreationTime = &v return s } -// SetDataSize sets the DataSize field's value. -func (s *DescribeDatasetImportJobOutput) SetDataSize(v float64) *DescribeDatasetImportJobOutput { - s.DataSize = &v - return s -} - -// SetDataSource sets the DataSource field's value. -func (s *DescribeDatasetImportJobOutput) SetDataSource(v *DataSource) *DescribeDatasetImportJobOutput { - s.DataSource = v - return s -} - -// SetDatasetArn sets the DatasetArn field's value. -func (s *DescribeDatasetImportJobOutput) SetDatasetArn(v string) *DescribeDatasetImportJobOutput { - s.DatasetArn = &v - return s -} - -// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. -func (s *DescribeDatasetImportJobOutput) SetDatasetImportJobArn(v string) *DescribeDatasetImportJobOutput { - s.DatasetImportJobArn = &v - return s -} - -// SetDatasetImportJobName sets the DatasetImportJobName field's value. -func (s *DescribeDatasetImportJobOutput) SetDatasetImportJobName(v string) *DescribeDatasetImportJobOutput { - s.DatasetImportJobName = &v +// SetDestination sets the Destination field's value. +func (s *DescribeExplainabilityExportOutput) SetDestination(v *DataDestination) *DescribeExplainabilityExportOutput { + s.Destination = v return s } -// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value. -func (s *DescribeDatasetImportJobOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeDatasetImportJobOutput { - s.EstimatedTimeRemainingInMinutes = &v +// SetExplainabilityArn sets the ExplainabilityArn field's value. +func (s *DescribeExplainabilityExportOutput) SetExplainabilityArn(v string) *DescribeExplainabilityExportOutput { + s.ExplainabilityArn = &v return s } -// SetFieldStatistics sets the FieldStatistics field's value. -func (s *DescribeDatasetImportJobOutput) SetFieldStatistics(v map[string]*Statistics) *DescribeDatasetImportJobOutput { - s.FieldStatistics = v +// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value. +func (s *DescribeExplainabilityExportOutput) SetExplainabilityExportArn(v string) *DescribeExplainabilityExportOutput { + s.ExplainabilityExportArn = &v return s } -// SetGeolocationFormat sets the GeolocationFormat field's value. -func (s *DescribeDatasetImportJobOutput) SetGeolocationFormat(v string) *DescribeDatasetImportJobOutput { - s.GeolocationFormat = &v +// SetExplainabilityExportName sets the ExplainabilityExportName field's value. +func (s *DescribeExplainabilityExportOutput) SetExplainabilityExportName(v string) *DescribeExplainabilityExportOutput { + s.ExplainabilityExportName = &v return s } // SetLastModificationTime sets the LastModificationTime field's value. -func (s *DescribeDatasetImportJobOutput) SetLastModificationTime(v time.Time) *DescribeDatasetImportJobOutput { +func (s *DescribeExplainabilityExportOutput) SetLastModificationTime(v time.Time) *DescribeExplainabilityExportOutput { s.LastModificationTime = &v return s } // SetMessage sets the Message field's value. -func (s *DescribeDatasetImportJobOutput) SetMessage(v string) *DescribeDatasetImportJobOutput { +func (s *DescribeExplainabilityExportOutput) SetMessage(v string) *DescribeExplainabilityExportOutput { s.Message = &v return s } // SetStatus sets the Status field's value. -func (s *DescribeDatasetImportJobOutput) SetStatus(v string) *DescribeDatasetImportJobOutput { +func (s *DescribeExplainabilityExportOutput) SetStatus(v string) *DescribeExplainabilityExportOutput { s.Status = &v return s } -// SetTimeZone sets the TimeZone field's value. -func (s *DescribeDatasetImportJobOutput) SetTimeZone(v string) *DescribeDatasetImportJobOutput { - s.TimeZone = &v - return s -} - -// SetTimestampFormat sets the TimestampFormat field's value. -func (s *DescribeDatasetImportJobOutput) SetTimestampFormat(v string) *DescribeDatasetImportJobOutput { - s.TimestampFormat = &v - return s -} - -// SetUseGeolocationForTimeZone sets the UseGeolocationForTimeZone field's value. -func (s *DescribeDatasetImportJobOutput) SetUseGeolocationForTimeZone(v bool) *DescribeDatasetImportJobOutput { - s.UseGeolocationForTimeZone = &v - return s -} - -type DescribeDatasetInput struct { +type DescribeExplainabilityInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset. + // The Amazon Resource Name (ARN) of the Explaianability to describe. // - // DatasetArn is a required field - DatasetArn *string `type:"string" required:"true"` + // ExplainabilityArn is a required field + ExplainabilityArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -6740,7 +9520,7 @@ type DescribeDatasetInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeDatasetInput) String() string { +func (s DescribeExplainabilityInput) String() string { return awsutil.Prettify(s) } @@ -6749,15 +9529,15 @@ func (s DescribeDatasetInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeDatasetInput) GoString() string { +func (s DescribeExplainabilityInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeDatasetInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeDatasetInput"} - if s.DatasetArn == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetArn")) +func (s *DescribeExplainabilityInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeExplainabilityInput"} + if s.ExplainabilityArn == nil { + invalidParams.Add(request.NewErrParamRequired("ExplainabilityArn")) } if invalidParams.Len() > 0 { @@ -6766,69 +9546,81 @@ func (s *DescribeDatasetInput) Validate() error { return nil } -// SetDatasetArn sets the DatasetArn field's value. -func (s *DescribeDatasetInput) SetDatasetArn(v string) *DescribeDatasetInput { - s.DatasetArn = &v +// SetExplainabilityArn sets the ExplainabilityArn field's value. +func (s *DescribeExplainabilityInput) SetExplainabilityArn(v string) *DescribeExplainabilityInput { + s.ExplainabilityArn = &v return s } -type DescribeDatasetOutput struct { +type DescribeExplainabilityOutput struct { _ struct{} `type:"structure"` - // When the dataset was created. + // When the Explainability resource was created. CreationTime *time.Time `type:"timestamp"` - // The frequency of data collection. - // - // Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min - // (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and - // 1min (1 minute). For example, "M" indicates every month and "30min" indicates - // every 30 minutes. - DataFrequency *string `type:"string"` + // The source of your training data, an AWS Identity and Access Management (IAM) + // role that allows Amazon Forecast to access the data and, optionally, an AWS + // Key Management Service (KMS) key. This object is submitted in the CreateDatasetImportJob + // request. + DataSource *DataSource `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset. - DatasetArn *string `type:"string"` + // Whether the visualization was enabled for the Explainability resource. + EnableVisualization *bool `type:"boolean"` - // The name of the dataset. - DatasetName *string `min:"1" type:"string"` + // If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability. + EndDateTime *string `type:"string"` - // The dataset type. - DatasetType *string `type:"string" enum:"DatasetType"` + // The estimated time remaining in minutes for the CreateExplainability job + // to complete. + EstimatedTimeRemainingInMinutes *int64 `type:"long"` - // The domain associated with the dataset. - Domain *string `type:"string" enum:"Domain"` + // The Amazon Resource Name (ARN) of the Explainability. + ExplainabilityArn *string `type:"string"` - // The AWS Key Management Service (KMS) key and the AWS Identity and Access - // Management (IAM) role that Amazon Forecast can assume to access the key. - EncryptionConfig *EncryptionConfig `type:"structure"` + // The configuration settings that define the granularity of time series and + // time points for the Explainability. + ExplainabilityConfig *ExplainabilityConfig `type:"structure"` - // When you create a dataset, LastModificationTime is the same as CreationTime. - // While data is being imported to the dataset, LastModificationTime is the - // current time of the DescribeDataset call. After a CreateDatasetImportJob - // operation has finished, LastModificationTime is when the import job completed - // or failed. + // The name of the Explainability. + ExplainabilityName *string `min:"1" type:"string"` + + // The last time the resource was modified. The timestamp depends on the status + // of the job: + // + // * CREATE_PENDING - The CreationTime. + // + // * CREATE_IN_PROGRESS - The current timestamp. + // + // * CREATE_STOPPING - The current timestamp. + // + // * CREATE_STOPPED - When the job stopped. + // + // * ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time `type:"timestamp"` - // An array of SchemaAttribute objects that specify the dataset fields. Each - // SchemaAttribute specifies the name and data type of a field. + // If an error occurred, a message about the error. + Message *string `type:"string"` + + // The Amazon Resource Name (ARN) of the Predictor or Forecast used to create + // the Explainability resource. + ResourceArn *string `type:"string"` + + // Defines the fields of a dataset. You specify this object in the CreateDataset + // request. Schema *Schema `type:"structure"` - // The status of the dataset. States include: + // If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability. + StartDateTime *string `type:"string"` + + // The status of the Explainability resource. States include: // // * ACTIVE // // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - // - // * UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED - // - // The UPDATE states apply while data is imported to the dataset from a call - // to the CreateDatasetImportJob operation and reflect the status of the dataset - // import job. For example, when the import job status is CREATE_IN_PROGRESS, - // the status of the dataset is UPDATE_IN_PROGRESS. + // * CREATE_STOPPING, CREATE_STOPPED // - // The Status of the dataset must be ACTIVE before you can import training data. + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED Status *string `type:"string"` } @@ -6837,7 +9629,7 @@ type DescribeDatasetOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeDatasetOutput) String() string { +func (s DescribeExplainabilityOutput) String() string { return awsutil.Prettify(s) } @@ -6846,66 +9638,90 @@ func (s DescribeDatasetOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeDatasetOutput) GoString() string { +func (s DescribeExplainabilityOutput) GoString() string { return s.String() } // SetCreationTime sets the CreationTime field's value. -func (s *DescribeDatasetOutput) SetCreationTime(v time.Time) *DescribeDatasetOutput { +func (s *DescribeExplainabilityOutput) SetCreationTime(v time.Time) *DescribeExplainabilityOutput { s.CreationTime = &v return s } -// SetDataFrequency sets the DataFrequency field's value. -func (s *DescribeDatasetOutput) SetDataFrequency(v string) *DescribeDatasetOutput { - s.DataFrequency = &v +// SetDataSource sets the DataSource field's value. +func (s *DescribeExplainabilityOutput) SetDataSource(v *DataSource) *DescribeExplainabilityOutput { + s.DataSource = v return s } -// SetDatasetArn sets the DatasetArn field's value. -func (s *DescribeDatasetOutput) SetDatasetArn(v string) *DescribeDatasetOutput { - s.DatasetArn = &v +// SetEnableVisualization sets the EnableVisualization field's value. +func (s *DescribeExplainabilityOutput) SetEnableVisualization(v bool) *DescribeExplainabilityOutput { + s.EnableVisualization = &v return s } -// SetDatasetName sets the DatasetName field's value. -func (s *DescribeDatasetOutput) SetDatasetName(v string) *DescribeDatasetOutput { - s.DatasetName = &v +// SetEndDateTime sets the EndDateTime field's value. +func (s *DescribeExplainabilityOutput) SetEndDateTime(v string) *DescribeExplainabilityOutput { + s.EndDateTime = &v return s } -// SetDatasetType sets the DatasetType field's value. -func (s *DescribeDatasetOutput) SetDatasetType(v string) *DescribeDatasetOutput { - s.DatasetType = &v +// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value. +func (s *DescribeExplainabilityOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeExplainabilityOutput { + s.EstimatedTimeRemainingInMinutes = &v return s } -// SetDomain sets the Domain field's value. -func (s *DescribeDatasetOutput) SetDomain(v string) *DescribeDatasetOutput { - s.Domain = &v +// SetExplainabilityArn sets the ExplainabilityArn field's value. +func (s *DescribeExplainabilityOutput) SetExplainabilityArn(v string) *DescribeExplainabilityOutput { + s.ExplainabilityArn = &v return s } -// SetEncryptionConfig sets the EncryptionConfig field's value. -func (s *DescribeDatasetOutput) SetEncryptionConfig(v *EncryptionConfig) *DescribeDatasetOutput { - s.EncryptionConfig = v +// SetExplainabilityConfig sets the ExplainabilityConfig field's value. +func (s *DescribeExplainabilityOutput) SetExplainabilityConfig(v *ExplainabilityConfig) *DescribeExplainabilityOutput { + s.ExplainabilityConfig = v + return s +} + +// SetExplainabilityName sets the ExplainabilityName field's value. +func (s *DescribeExplainabilityOutput) SetExplainabilityName(v string) *DescribeExplainabilityOutput { + s.ExplainabilityName = &v + return s +} + +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DescribeExplainabilityOutput) SetLastModificationTime(v time.Time) *DescribeExplainabilityOutput { + s.LastModificationTime = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *DescribeExplainabilityOutput) SetMessage(v string) *DescribeExplainabilityOutput { + s.Message = &v return s } -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *DescribeDatasetOutput) SetLastModificationTime(v time.Time) *DescribeDatasetOutput { - s.LastModificationTime = &v +// SetResourceArn sets the ResourceArn field's value. +func (s *DescribeExplainabilityOutput) SetResourceArn(v string) *DescribeExplainabilityOutput { + s.ResourceArn = &v return s } // SetSchema sets the Schema field's value. -func (s *DescribeDatasetOutput) SetSchema(v *Schema) *DescribeDatasetOutput { +func (s *DescribeExplainabilityOutput) SetSchema(v *Schema) *DescribeExplainabilityOutput { s.Schema = v return s } +// SetStartDateTime sets the StartDateTime field's value. +func (s *DescribeExplainabilityOutput) SetStartDateTime(v string) *DescribeExplainabilityOutput { + s.StartDateTime = &v + return s +} + // SetStatus sets the Status field's value. -func (s *DescribeDatasetOutput) SetStatus(v string) *DescribeDatasetOutput { +func (s *DescribeExplainabilityOutput) SetStatus(v string) *DescribeExplainabilityOutput { s.Status = &v return s } @@ -7518,6 +10334,9 @@ type DescribePredictorOutput struct { // Describes the dataset group that contains the data to use to train the predictor. InputDataConfig *InputDataConfig `type:"structure"` + // Whether the predictor was created with CreateAutoPredictor. + IsAutoPredictor *bool `type:"boolean"` + // The last time the resource was modified. The timestamp depends on the status // of the job: // @@ -7569,11 +10388,261 @@ type DescribePredictorOutput struct { // to create a forecast. Status *string `type:"string"` - // The default training parameters or overrides selected during model training. - // When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized - // values for the chosen hyperparameters are returned. For more information, - // see aws-forecast-choosing-recipes. - TrainingParameters map[string]*string `type:"map"` + // The default training parameters or overrides selected during model training. + // When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized + // values for the chosen hyperparameters are returned. For more information, + // see aws-forecast-choosing-recipes. + TrainingParameters map[string]*string `type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePredictorOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribePredictorOutput) GoString() string { + return s.String() +} + +// SetAlgorithmArn sets the AlgorithmArn field's value. +func (s *DescribePredictorOutput) SetAlgorithmArn(v string) *DescribePredictorOutput { + s.AlgorithmArn = &v + return s +} + +// SetAutoMLAlgorithmArns sets the AutoMLAlgorithmArns field's value. +func (s *DescribePredictorOutput) SetAutoMLAlgorithmArns(v []*string) *DescribePredictorOutput { + s.AutoMLAlgorithmArns = v + return s +} + +// SetAutoMLOverrideStrategy sets the AutoMLOverrideStrategy field's value. +func (s *DescribePredictorOutput) SetAutoMLOverrideStrategy(v string) *DescribePredictorOutput { + s.AutoMLOverrideStrategy = &v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *DescribePredictorOutput) SetCreationTime(v time.Time) *DescribePredictorOutput { + s.CreationTime = &v + return s +} + +// SetDatasetImportJobArns sets the DatasetImportJobArns field's value. +func (s *DescribePredictorOutput) SetDatasetImportJobArns(v []*string) *DescribePredictorOutput { + s.DatasetImportJobArns = v + return s +} + +// SetEncryptionConfig sets the EncryptionConfig field's value. +func (s *DescribePredictorOutput) SetEncryptionConfig(v *EncryptionConfig) *DescribePredictorOutput { + s.EncryptionConfig = v + return s +} + +// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value. +func (s *DescribePredictorOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribePredictorOutput { + s.EstimatedTimeRemainingInMinutes = &v + return s +} + +// SetEvaluationParameters sets the EvaluationParameters field's value. +func (s *DescribePredictorOutput) SetEvaluationParameters(v *EvaluationParameters) *DescribePredictorOutput { + s.EvaluationParameters = v + return s +} + +// SetFeaturizationConfig sets the FeaturizationConfig field's value. +func (s *DescribePredictorOutput) SetFeaturizationConfig(v *FeaturizationConfig) *DescribePredictorOutput { + s.FeaturizationConfig = v + return s +} + +// SetForecastHorizon sets the ForecastHorizon field's value. +func (s *DescribePredictorOutput) SetForecastHorizon(v int64) *DescribePredictorOutput { + s.ForecastHorizon = &v + return s +} + +// SetForecastTypes sets the ForecastTypes field's value. +func (s *DescribePredictorOutput) SetForecastTypes(v []*string) *DescribePredictorOutput { + s.ForecastTypes = v + return s +} + +// SetHPOConfig sets the HPOConfig field's value. +func (s *DescribePredictorOutput) SetHPOConfig(v *HyperParameterTuningJobConfig) *DescribePredictorOutput { + s.HPOConfig = v + return s +} + +// SetInputDataConfig sets the InputDataConfig field's value. +func (s *DescribePredictorOutput) SetInputDataConfig(v *InputDataConfig) *DescribePredictorOutput { + s.InputDataConfig = v + return s +} + +// SetIsAutoPredictor sets the IsAutoPredictor field's value. +func (s *DescribePredictorOutput) SetIsAutoPredictor(v bool) *DescribePredictorOutput { + s.IsAutoPredictor = &v + return s +} + +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DescribePredictorOutput) SetLastModificationTime(v time.Time) *DescribePredictorOutput { + s.LastModificationTime = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *DescribePredictorOutput) SetMessage(v string) *DescribePredictorOutput { + s.Message = &v + return s +} + +// SetOptimizationMetric sets the OptimizationMetric field's value. +func (s *DescribePredictorOutput) SetOptimizationMetric(v string) *DescribePredictorOutput { + s.OptimizationMetric = &v + return s +} + +// SetPerformAutoML sets the PerformAutoML field's value. +func (s *DescribePredictorOutput) SetPerformAutoML(v bool) *DescribePredictorOutput { + s.PerformAutoML = &v + return s +} + +// SetPerformHPO sets the PerformHPO field's value. +func (s *DescribePredictorOutput) SetPerformHPO(v bool) *DescribePredictorOutput { + s.PerformHPO = &v + return s +} + +// SetPredictorArn sets the PredictorArn field's value. +func (s *DescribePredictorOutput) SetPredictorArn(v string) *DescribePredictorOutput { + s.PredictorArn = &v + return s +} + +// SetPredictorExecutionDetails sets the PredictorExecutionDetails field's value. +func (s *DescribePredictorOutput) SetPredictorExecutionDetails(v *PredictorExecutionDetails) *DescribePredictorOutput { + s.PredictorExecutionDetails = v + return s +} + +// SetPredictorName sets the PredictorName field's value. +func (s *DescribePredictorOutput) SetPredictorName(v string) *DescribePredictorOutput { + s.PredictorName = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribePredictorOutput) SetStatus(v string) *DescribePredictorOutput { + s.Status = &v + return s +} + +// SetTrainingParameters sets the TrainingParameters field's value. +func (s *DescribePredictorOutput) SetTrainingParameters(v map[string]*string) *DescribePredictorOutput { + s.TrainingParameters = v + return s +} + +// An AWS Key Management Service (KMS) key and an AWS Identity and Access Management +// (IAM) role that Amazon Forecast can assume to access the key. You can specify +// this optional object in the CreateDataset and CreatePredictor requests. +type EncryptionConfig struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the KMS key. + // + // KMSKeyArn is a required field + KMSKeyArn *string `type:"string" required:"true"` + + // The ARN of the IAM role that Amazon Forecast can assume to access the AWS + // KMS key. + // + // Passing a role across AWS accounts is not allowed. If you pass a role that + // isn't in your account, you get an InvalidInputException error. + // + // RoleArn is a required field + RoleArn *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EncryptionConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EncryptionConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EncryptionConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EncryptionConfig"} + if s.KMSKeyArn == nil { + invalidParams.Add(request.NewErrParamRequired("KMSKeyArn")) + } + if s.RoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("RoleArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKMSKeyArn sets the KMSKeyArn field's value. +func (s *EncryptionConfig) SetKMSKeyArn(v string) *EncryptionConfig { + s.KMSKeyArn = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *EncryptionConfig) SetRoleArn(v string) *EncryptionConfig { + s.RoleArn = &v + return s +} + +// Provides detailed error metrics to evaluate the performance of a predictor. +// This object is part of the Metrics object. +type ErrorMetric struct { + _ struct{} `type:"structure"` + + // The Forecast type used to compute WAPE, MAPE, MASE, and RMSE. + ForecastType *string `min:"2" type:"string"` + + // The Mean Absolute Percentage Error (MAPE) + MAPE *float64 `type:"double"` + + // The Mean Absolute Scaled Error (MASE) + MASE *float64 `type:"double"` + + // The root-mean-square error (RMSE). + RMSE *float64 `type:"double"` + + // The weighted absolute percentage error (WAPE). + WAPE *float64 `type:"double"` } // String returns the string representation. @@ -7581,7 +10650,7 @@ type DescribePredictorOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribePredictorOutput) String() string { +func (s ErrorMetric) String() string { return awsutil.Prettify(s) } @@ -7590,167 +10659,264 @@ func (s DescribePredictorOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribePredictorOutput) GoString() string { +func (s ErrorMetric) GoString() string { return s.String() } -// SetAlgorithmArn sets the AlgorithmArn field's value. -func (s *DescribePredictorOutput) SetAlgorithmArn(v string) *DescribePredictorOutput { - s.AlgorithmArn = &v +// SetForecastType sets the ForecastType field's value. +func (s *ErrorMetric) SetForecastType(v string) *ErrorMetric { + s.ForecastType = &v return s } -// SetAutoMLAlgorithmArns sets the AutoMLAlgorithmArns field's value. -func (s *DescribePredictorOutput) SetAutoMLAlgorithmArns(v []*string) *DescribePredictorOutput { - s.AutoMLAlgorithmArns = v +// SetMAPE sets the MAPE field's value. +func (s *ErrorMetric) SetMAPE(v float64) *ErrorMetric { + s.MAPE = &v return s } -// SetAutoMLOverrideStrategy sets the AutoMLOverrideStrategy field's value. -func (s *DescribePredictorOutput) SetAutoMLOverrideStrategy(v string) *DescribePredictorOutput { - s.AutoMLOverrideStrategy = &v +// SetMASE sets the MASE field's value. +func (s *ErrorMetric) SetMASE(v float64) *ErrorMetric { + s.MASE = &v return s } -// SetCreationTime sets the CreationTime field's value. -func (s *DescribePredictorOutput) SetCreationTime(v time.Time) *DescribePredictorOutput { - s.CreationTime = &v +// SetRMSE sets the RMSE field's value. +func (s *ErrorMetric) SetRMSE(v float64) *ErrorMetric { + s.RMSE = &v return s } -// SetDatasetImportJobArns sets the DatasetImportJobArns field's value. -func (s *DescribePredictorOutput) SetDatasetImportJobArns(v []*string) *DescribePredictorOutput { - s.DatasetImportJobArns = v +// SetWAPE sets the WAPE field's value. +func (s *ErrorMetric) SetWAPE(v float64) *ErrorMetric { + s.WAPE = &v return s } -// SetEncryptionConfig sets the EncryptionConfig field's value. -func (s *DescribePredictorOutput) SetEncryptionConfig(v *EncryptionConfig) *DescribePredictorOutput { - s.EncryptionConfig = v - return s -} +// Parameters that define how to split a dataset into training data and testing +// data, and the number of iterations to perform. These parameters are specified +// in the predefined algorithms but you can override them in the CreatePredictor +// request. +type EvaluationParameters struct { + _ struct{} `type:"structure"` -// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value. -func (s *DescribePredictorOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribePredictorOutput { - s.EstimatedTimeRemainingInMinutes = &v - return s -} + // The point from the end of the dataset where you want to split the data for + // model training and testing (evaluation). Specify the value as the number + // of data points. The default is the value of the forecast horizon. BackTestWindowOffset + // can be used to mimic a past virtual forecast start date. This value must + // be greater than or equal to the forecast horizon and less than half of the + // TARGET_TIME_SERIES dataset length. + // + // ForecastHorizon <= BackTestWindowOffset < 1/2 * TARGET_TIME_SERIES dataset + // length + BackTestWindowOffset *int64 `type:"integer"` -// SetEvaluationParameters sets the EvaluationParameters field's value. -func (s *DescribePredictorOutput) SetEvaluationParameters(v *EvaluationParameters) *DescribePredictorOutput { - s.EvaluationParameters = v - return s + // The number of times to split the input data. The default is 1. Valid values + // are 1 through 5. + NumberOfBacktestWindows *int64 `type:"integer"` } -// SetFeaturizationConfig sets the FeaturizationConfig field's value. -func (s *DescribePredictorOutput) SetFeaturizationConfig(v *FeaturizationConfig) *DescribePredictorOutput { - s.FeaturizationConfig = v - return s +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EvaluationParameters) String() string { + return awsutil.Prettify(s) } -// SetForecastHorizon sets the ForecastHorizon field's value. -func (s *DescribePredictorOutput) SetForecastHorizon(v int64) *DescribePredictorOutput { - s.ForecastHorizon = &v - return s +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EvaluationParameters) GoString() string { + return s.String() } -// SetForecastTypes sets the ForecastTypes field's value. -func (s *DescribePredictorOutput) SetForecastTypes(v []*string) *DescribePredictorOutput { - s.ForecastTypes = v +// SetBackTestWindowOffset sets the BackTestWindowOffset field's value. +func (s *EvaluationParameters) SetBackTestWindowOffset(v int64) *EvaluationParameters { + s.BackTestWindowOffset = &v return s } -// SetHPOConfig sets the HPOConfig field's value. -func (s *DescribePredictorOutput) SetHPOConfig(v *HyperParameterTuningJobConfig) *DescribePredictorOutput { - s.HPOConfig = v +// SetNumberOfBacktestWindows sets the NumberOfBacktestWindows field's value. +func (s *EvaluationParameters) SetNumberOfBacktestWindows(v int64) *EvaluationParameters { + s.NumberOfBacktestWindows = &v return s } -// SetInputDataConfig sets the InputDataConfig field's value. -func (s *DescribePredictorOutput) SetInputDataConfig(v *InputDataConfig) *DescribePredictorOutput { - s.InputDataConfig = v - return s +// The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics +// response. +type EvaluationResult struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the algorithm that was evaluated. + AlgorithmArn *string `type:"string"` + + // The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows + // from the EvaluationParameters object determines the number of windows in + // the array. + TestWindows []*WindowSummary `type:"list"` } -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *DescribePredictorOutput) SetLastModificationTime(v time.Time) *DescribePredictorOutput { - s.LastModificationTime = &v - return s +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EvaluationResult) String() string { + return awsutil.Prettify(s) } -// SetMessage sets the Message field's value. -func (s *DescribePredictorOutput) SetMessage(v string) *DescribePredictorOutput { - s.Message = &v - return s +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EvaluationResult) GoString() string { + return s.String() } -// SetOptimizationMetric sets the OptimizationMetric field's value. -func (s *DescribePredictorOutput) SetOptimizationMetric(v string) *DescribePredictorOutput { - s.OptimizationMetric = &v +// SetAlgorithmArn sets the AlgorithmArn field's value. +func (s *EvaluationResult) SetAlgorithmArn(v string) *EvaluationResult { + s.AlgorithmArn = &v return s } -// SetPerformAutoML sets the PerformAutoML field's value. -func (s *DescribePredictorOutput) SetPerformAutoML(v bool) *DescribePredictorOutput { - s.PerformAutoML = &v +// SetTestWindows sets the TestWindows field's value. +func (s *EvaluationResult) SetTestWindows(v []*WindowSummary) *EvaluationResult { + s.TestWindows = v return s } -// SetPerformHPO sets the PerformHPO field's value. -func (s *DescribePredictorOutput) SetPerformHPO(v bool) *DescribePredictorOutput { - s.PerformHPO = &v - return s +// The ExplainabilityConfig data type defines the number of time series and +// time points included in CreateExplainability. +// +// If you provide a predictor ARN for ResourceArn, you must set both TimePointGranularity +// and TimeSeriesGranularity to “ALL”. When creating Predictor Explainability, +// Amazon Forecast considers all time series and time points. +// +// If you provide a forecast ARN for ResourceArn, you can set TimePointGranularity +// and TimeSeriesGranularity to either “ALL” or “Specific”. +type ExplainabilityConfig struct { + _ struct{} `type:"structure"` + + // To create an Explainability for all time points in your forecast horizon, + // use ALL. To create an Explainability for specific time points in your forecast + // horizon, use SPECIFIC. + // + // Specify time points with the StartDateTime and EndDateTime parameters within + // the CreateExplainability operation. + // + // TimePointGranularity is a required field + TimePointGranularity *string `type:"string" required:"true" enum:"TimePointGranularity"` + + // To create an Explainability for all time series in your datasets, use ALL. + // To create an Explainability for specific time series in your datasets, use + // SPECIFIC. + // + // Specify time series by uploading a CSV file to an Amazon S3 bucket and set + // the location within the DataDestination data type. + // + // TimeSeriesGranularity is a required field + TimeSeriesGranularity *string `type:"string" required:"true" enum:"TimeSeriesGranularity"` } -// SetPredictorArn sets the PredictorArn field's value. -func (s *DescribePredictorOutput) SetPredictorArn(v string) *DescribePredictorOutput { - s.PredictorArn = &v - return s +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ExplainabilityConfig) String() string { + return awsutil.Prettify(s) } -// SetPredictorExecutionDetails sets the PredictorExecutionDetails field's value. -func (s *DescribePredictorOutput) SetPredictorExecutionDetails(v *PredictorExecutionDetails) *DescribePredictorOutput { - s.PredictorExecutionDetails = v - return s +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ExplainabilityConfig) GoString() string { + return s.String() } -// SetPredictorName sets the PredictorName field's value. -func (s *DescribePredictorOutput) SetPredictorName(v string) *DescribePredictorOutput { - s.PredictorName = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *ExplainabilityConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ExplainabilityConfig"} + if s.TimePointGranularity == nil { + invalidParams.Add(request.NewErrParamRequired("TimePointGranularity")) + } + if s.TimeSeriesGranularity == nil { + invalidParams.Add(request.NewErrParamRequired("TimeSeriesGranularity")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetStatus sets the Status field's value. -func (s *DescribePredictorOutput) SetStatus(v string) *DescribePredictorOutput { - s.Status = &v +// SetTimePointGranularity sets the TimePointGranularity field's value. +func (s *ExplainabilityConfig) SetTimePointGranularity(v string) *ExplainabilityConfig { + s.TimePointGranularity = &v return s } -// SetTrainingParameters sets the TrainingParameters field's value. -func (s *DescribePredictorOutput) SetTrainingParameters(v map[string]*string) *DescribePredictorOutput { - s.TrainingParameters = v +// SetTimeSeriesGranularity sets the TimeSeriesGranularity field's value. +func (s *ExplainabilityConfig) SetTimeSeriesGranularity(v string) *ExplainabilityConfig { + s.TimeSeriesGranularity = &v return s } -// An AWS Key Management Service (KMS) key and an AWS Identity and Access Management -// (IAM) role that Amazon Forecast can assume to access the key. You can specify -// this optional object in the CreateDataset and CreatePredictor requests. -type EncryptionConfig struct { +// Provides a summary of the Explainability export properties used in the ListExplainabilityExports +// operation. To get a complete set of properties, call the DescribeExplainabilityExport +// operation, and provide the ExplainabilityExportArn. +type ExplainabilityExportSummary struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the KMS key. + // When the Explainability was created. + CreationTime *time.Time `type:"timestamp"` + + // The destination for an export job. Provide an S3 path, an AWS Identity and + // Access Management (IAM) role that allows Amazon Forecast to access the location, + // and an AWS Key Management Service (KMS) key (optional). + Destination *DataDestination `type:"structure"` + + // The Amazon Resource Name (ARN) of the Explainability export. + ExplainabilityExportArn *string `type:"string"` + + // The name of the Explainability export + ExplainabilityExportName *string `min:"1" type:"string"` + + // The last time the resource was modified. The timestamp depends on the status + // of the job: // - // KMSKeyArn is a required field - KMSKeyArn *string `type:"string" required:"true"` + // * CREATE_PENDING - The CreationTime. + // + // * CREATE_IN_PROGRESS - The current timestamp. + // + // * CREATE_STOPPING - The current timestamp. + // + // * CREATE_STOPPED - When the job stopped. + // + // * ACTIVE or CREATE_FAILED - When the job finished or failed. + LastModificationTime *time.Time `type:"timestamp"` - // The ARN of the IAM role that Amazon Forecast can assume to access the AWS - // KMS key. + // Information about any errors that may have occurred during the Explainability + // export. + Message *string `type:"string"` + + // The status of the Explainability export. States include: // - // Passing a role across AWS accounts is not allowed. If you pass a role that - // isn't in your account, you get an InvalidInputException error. + // * ACTIVE // - // RoleArn is a required field - RoleArn *string `type:"string" required:"true"` + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * CREATE_STOPPING, CREATE_STOPPED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + Status *string `type:"string"` } // String returns the string representation. @@ -7758,7 +10924,7 @@ type EncryptionConfig struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s EncryptionConfig) String() string { +func (s ExplainabilityExportSummary) String() string { return awsutil.Prettify(s) } @@ -7767,57 +10933,58 @@ func (s EncryptionConfig) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s EncryptionConfig) GoString() string { +func (s ExplainabilityExportSummary) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *EncryptionConfig) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "EncryptionConfig"} - if s.KMSKeyArn == nil { - invalidParams.Add(request.NewErrParamRequired("KMSKeyArn")) - } - if s.RoleArn == nil { - invalidParams.Add(request.NewErrParamRequired("RoleArn")) - } +// SetCreationTime sets the CreationTime field's value. +func (s *ExplainabilityExportSummary) SetCreationTime(v time.Time) *ExplainabilityExportSummary { + s.CreationTime = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetDestination sets the Destination field's value. +func (s *ExplainabilityExportSummary) SetDestination(v *DataDestination) *ExplainabilityExportSummary { + s.Destination = v + return s } -// SetKMSKeyArn sets the KMSKeyArn field's value. -func (s *EncryptionConfig) SetKMSKeyArn(v string) *EncryptionConfig { - s.KMSKeyArn = &v +// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value. +func (s *ExplainabilityExportSummary) SetExplainabilityExportArn(v string) *ExplainabilityExportSummary { + s.ExplainabilityExportArn = &v return s } -// SetRoleArn sets the RoleArn field's value. -func (s *EncryptionConfig) SetRoleArn(v string) *EncryptionConfig { - s.RoleArn = &v +// SetExplainabilityExportName sets the ExplainabilityExportName field's value. +func (s *ExplainabilityExportSummary) SetExplainabilityExportName(v string) *ExplainabilityExportSummary { + s.ExplainabilityExportName = &v return s } -// Provides detailed error metrics to evaluate the performance of a predictor. -// This object is part of the Metrics object. -type ErrorMetric struct { - _ struct{} `type:"structure"` +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *ExplainabilityExportSummary) SetLastModificationTime(v time.Time) *ExplainabilityExportSummary { + s.LastModificationTime = &v + return s +} - // The Forecast type used to compute WAPE, MAPE, MASE, and RMSE. - ForecastType *string `type:"string"` +// SetMessage sets the Message field's value. +func (s *ExplainabilityExportSummary) SetMessage(v string) *ExplainabilityExportSummary { + s.Message = &v + return s +} - // The Mean Absolute Percentage Error (MAPE) - MAPE *float64 `type:"double"` +// SetStatus sets the Status field's value. +func (s *ExplainabilityExportSummary) SetStatus(v string) *ExplainabilityExportSummary { + s.Status = &v + return s +} - // The Mean Absolute Scaled Error (MASE) - MASE *float64 `type:"double"` +type ExplainabilityInfo struct { + _ struct{} `type:"structure"` - // The root-mean-square error (RMSE). - RMSE *float64 `type:"double"` + ExplainabilityArn *string `type:"string"` - // The weighted absolute percentage error (WAPE). - WAPE *float64 `type:"double"` + Status *string `type:"string"` } // String returns the string representation. @@ -7825,7 +10992,7 @@ type ErrorMetric struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ErrorMetric) String() string { +func (s ExplainabilityInfo) String() string { return awsutil.Prettify(s) } @@ -7834,61 +11001,73 @@ func (s ErrorMetric) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ErrorMetric) GoString() string { +func (s ExplainabilityInfo) GoString() string { return s.String() } -// SetForecastType sets the ForecastType field's value. -func (s *ErrorMetric) SetForecastType(v string) *ErrorMetric { - s.ForecastType = &v +// SetExplainabilityArn sets the ExplainabilityArn field's value. +func (s *ExplainabilityInfo) SetExplainabilityArn(v string) *ExplainabilityInfo { + s.ExplainabilityArn = &v return s } -// SetMAPE sets the MAPE field's value. -func (s *ErrorMetric) SetMAPE(v float64) *ErrorMetric { - s.MAPE = &v +// SetStatus sets the Status field's value. +func (s *ExplainabilityInfo) SetStatus(v string) *ExplainabilityInfo { + s.Status = &v return s } -// SetMASE sets the MASE field's value. -func (s *ErrorMetric) SetMASE(v float64) *ErrorMetric { - s.MASE = &v - return s -} +// Provides a summary of the Explainability properties used in the ListExplainabilities +// operation. To get a complete set of properties, call the DescribeExplainability +// operation, and provide the listed ExplainabilityArn. +type ExplainabilitySummary struct { + _ struct{} `type:"structure"` -// SetRMSE sets the RMSE field's value. -func (s *ErrorMetric) SetRMSE(v float64) *ErrorMetric { - s.RMSE = &v - return s -} + // When the Explainability was created. + CreationTime *time.Time `type:"timestamp"` -// SetWAPE sets the WAPE field's value. -func (s *ErrorMetric) SetWAPE(v float64) *ErrorMetric { - s.WAPE = &v - return s -} + // The Amazon Resource Name (ARN) of the Explainability. + ExplainabilityArn *string `type:"string"` -// Parameters that define how to split a dataset into training data and testing -// data, and the number of iterations to perform. These parameters are specified -// in the predefined algorithms but you can override them in the CreatePredictor -// request. -type EvaluationParameters struct { - _ struct{} `type:"structure"` + // The configuration settings that define the granularity of time series and + // time points for the Explainability. + ExplainabilityConfig *ExplainabilityConfig `type:"structure"` - // The point from the end of the dataset where you want to split the data for - // model training and testing (evaluation). Specify the value as the number - // of data points. The default is the value of the forecast horizon. BackTestWindowOffset - // can be used to mimic a past virtual forecast start date. This value must - // be greater than or equal to the forecast horizon and less than half of the - // TARGET_TIME_SERIES dataset length. + // The name of the Explainability. + ExplainabilityName *string `min:"1" type:"string"` + + // The last time the resource was modified. The timestamp depends on the status + // of the job: // - // ForecastHorizon <= BackTestWindowOffset < 1/2 * TARGET_TIME_SERIES dataset - // length - BackTestWindowOffset *int64 `type:"integer"` + // * CREATE_PENDING - The CreationTime. + // + // * CREATE_IN_PROGRESS - The current timestamp. + // + // * CREATE_STOPPING - The current timestamp. + // + // * CREATE_STOPPED - When the job stopped. + // + // * ACTIVE or CREATE_FAILED - When the job finished or failed. + LastModificationTime *time.Time `type:"timestamp"` - // The number of times to split the input data. The default is 1. Valid values - // are 1 through 5. - NumberOfBacktestWindows *int64 `type:"integer"` + // Information about any errors that may have occurred during the Explainability + // creation process. + Message *string `type:"string"` + + // The Amazon Resource Name (ARN) of the Predictor or Forecast used to create + // the Explainability. + ResourceArn *string `type:"string"` + + // The status of the Explainability. States include: + // + // * ACTIVE + // + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * CREATE_STOPPING, CREATE_STOPPED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + Status *string `type:"string"` } // String returns the string representation. @@ -7896,7 +11075,7 @@ type EvaluationParameters struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s EvaluationParameters) String() string { +func (s ExplainabilitySummary) String() string { return awsutil.Prettify(s) } @@ -7905,63 +11084,55 @@ func (s EvaluationParameters) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s EvaluationParameters) GoString() string { +func (s ExplainabilitySummary) GoString() string { return s.String() } -// SetBackTestWindowOffset sets the BackTestWindowOffset field's value. -func (s *EvaluationParameters) SetBackTestWindowOffset(v int64) *EvaluationParameters { - s.BackTestWindowOffset = &v +// SetCreationTime sets the CreationTime field's value. +func (s *ExplainabilitySummary) SetCreationTime(v time.Time) *ExplainabilitySummary { + s.CreationTime = &v return s } -// SetNumberOfBacktestWindows sets the NumberOfBacktestWindows field's value. -func (s *EvaluationParameters) SetNumberOfBacktestWindows(v int64) *EvaluationParameters { - s.NumberOfBacktestWindows = &v +// SetExplainabilityArn sets the ExplainabilityArn field's value. +func (s *ExplainabilitySummary) SetExplainabilityArn(v string) *ExplainabilitySummary { + s.ExplainabilityArn = &v return s } -// The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics -// response. -type EvaluationResult struct { - _ struct{} `type:"structure"` - - // The Amazon Resource Name (ARN) of the algorithm that was evaluated. - AlgorithmArn *string `type:"string"` +// SetExplainabilityConfig sets the ExplainabilityConfig field's value. +func (s *ExplainabilitySummary) SetExplainabilityConfig(v *ExplainabilityConfig) *ExplainabilitySummary { + s.ExplainabilityConfig = v + return s +} - // The array of test windows used for evaluating the algorithm. The NumberOfBacktestWindows - // from the EvaluationParameters object determines the number of windows in - // the array. - TestWindows []*WindowSummary `type:"list"` +// SetExplainabilityName sets the ExplainabilityName field's value. +func (s *ExplainabilitySummary) SetExplainabilityName(v string) *ExplainabilitySummary { + s.ExplainabilityName = &v + return s } -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s EvaluationResult) String() string { - return awsutil.Prettify(s) +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *ExplainabilitySummary) SetLastModificationTime(v time.Time) *ExplainabilitySummary { + s.LastModificationTime = &v + return s } -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s EvaluationResult) GoString() string { - return s.String() +// SetMessage sets the Message field's value. +func (s *ExplainabilitySummary) SetMessage(v string) *ExplainabilitySummary { + s.Message = &v + return s } -// SetAlgorithmArn sets the AlgorithmArn field's value. -func (s *EvaluationResult) SetAlgorithmArn(v string) *EvaluationResult { - s.AlgorithmArn = &v +// SetResourceArn sets the ResourceArn field's value. +func (s *ExplainabilitySummary) SetResourceArn(v string) *ExplainabilitySummary { + s.ResourceArn = &v return s } -// SetTestWindows sets the TestWindows field's value. -func (s *EvaluationResult) SetTestWindows(v []*WindowSummary) *EvaluationResult { - s.TestWindows = v +// SetStatus sets the Status field's value. +func (s *ExplainabilitySummary) SetStatus(v string) *ExplainabilitySummary { + s.Status = &v return s } @@ -8108,7 +11279,7 @@ type FeaturizationConfig struct { // to the RELATED_TIME_SERIES dataset frequency. // // ForecastFrequency is a required field - ForecastFrequency *string `type:"string" required:"true"` + ForecastFrequency *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -8141,6 +11312,9 @@ func (s *FeaturizationConfig) Validate() error { if s.ForecastFrequency == nil { invalidParams.Add(request.NewErrParamRequired("ForecastFrequency")) } + if s.ForecastFrequency != nil && len(*s.ForecastFrequency) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ForecastFrequency", 1)) + } if s.Featurizations != nil { for i, v := range s.Featurizations { if v == nil { @@ -8472,6 +11646,8 @@ func (s *ForecastExportJobSummary) SetStatus(v string) *ForecastExportJobSummary type ForecastSummary struct { _ struct{} `type:"structure"` + CreatedUsingAutoPredictor *bool `type:"boolean"` + // When the forecast creation task was created. CreationTime *time.Time `type:"timestamp"` @@ -8538,6 +11714,12 @@ func (s ForecastSummary) GoString() string { return s.String() } +// SetCreatedUsingAutoPredictor sets the CreatedUsingAutoPredictor field's value. +func (s *ForecastSummary) SetCreatedUsingAutoPredictor(v bool) *ForecastSummary { + s.CreatedUsingAutoPredictor = &v + return s +} + // SetCreationTime sets the CreationTime field's value. func (s *ForecastSummary) SetCreationTime(v time.Time) *ForecastSummary { s.CreationTime = &v @@ -8646,6 +11828,9 @@ type GetAccuracyMetricsOutput struct { // This parameter is only valid for predictors trained using AutoML. AutoMLOverrideStrategy *string `type:"string" enum:"AutoMLOverrideStrategy"` + // Whether the predictor was created with CreateAutoPredictor. + IsAutoPredictor *bool `type:"boolean"` + // The accuracy metric used to optimize the predictor. OptimizationMetric *string `type:"string" enum:"OptimizationMetric"` @@ -8677,6 +11862,12 @@ func (s *GetAccuracyMetricsOutput) SetAutoMLOverrideStrategy(v string) *GetAccur return s } +// SetIsAutoPredictor sets the IsAutoPredictor field's value. +func (s *GetAccuracyMetricsOutput) SetIsAutoPredictor(v bool) *GetAccuracyMetricsOutput { + s.IsAutoPredictor = &v + return s +} + // SetOptimizationMetric sets the OptimizationMetric field's value. func (s *GetAccuracyMetricsOutput) SetOptimizationMetric(v string) *GetAccuracyMetricsOutput { s.OptimizationMetric = &v @@ -8924,21 +12115,85 @@ func (s *IntegerParameterRange) SetMinValue(v int64) *IntegerParameterRange { return s } -// SetName sets the Name field's value. -func (s *IntegerParameterRange) SetName(v string) *IntegerParameterRange { - s.Name = &v - return s +// SetName sets the Name field's value. +func (s *IntegerParameterRange) SetName(v string) *IntegerParameterRange { + s.Name = &v + return s +} + +// SetScalingType sets the ScalingType field's value. +func (s *IntegerParameterRange) SetScalingType(v string) *IntegerParameterRange { + s.ScalingType = &v + return s +} + +// We can't process the request because it includes an invalid value or a value +// that exceeds the valid range. +type InvalidInputException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InvalidInputException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InvalidInputException) GoString() string { + return s.String() +} + +func newErrorInvalidInputException(v protocol.ResponseMetadata) error { + return &InvalidInputException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *InvalidInputException) Code() string { + return "InvalidInputException" +} + +// Message returns the exception's message. +func (s *InvalidInputException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InvalidInputException) OrigErr() error { + return nil +} + +func (s *InvalidInputException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *InvalidInputException) StatusCode() int { + return s.RespMetadata.StatusCode } -// SetScalingType sets the ScalingType field's value. -func (s *IntegerParameterRange) SetScalingType(v string) *IntegerParameterRange { - s.ScalingType = &v - return s +// RequestID returns the service's response RequestID for request. +func (s *InvalidInputException) RequestID() string { + return s.RespMetadata.RequestID } -// We can't process the request because it includes an invalid value or a value -// that exceeds the valid range. -type InvalidInputException struct { +// The token is not valid. Tokens expire after 24 hours. +type InvalidNextTokenException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -8950,7 +12205,7 @@ type InvalidInputException struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s InvalidInputException) String() string { +func (s InvalidNextTokenException) String() string { return awsutil.Prettify(s) } @@ -8959,23 +12214,23 @@ func (s InvalidInputException) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s InvalidInputException) GoString() string { +func (s InvalidNextTokenException) GoString() string { return s.String() } -func newErrorInvalidInputException(v protocol.ResponseMetadata) error { - return &InvalidInputException{ +func newErrorInvalidNextTokenException(v protocol.ResponseMetadata) error { + return &InvalidNextTokenException{ RespMetadata: v, } } // Code returns the exception type name. -func (s *InvalidInputException) Code() string { - return "InvalidInputException" +func (s *InvalidNextTokenException) Code() string { + return "InvalidNextTokenException" } // Message returns the exception's message. -func (s *InvalidInputException) Message() string { +func (s *InvalidNextTokenException) Message() string { if s.Message_ != nil { return *s.Message_ } @@ -8983,26 +12238,26 @@ func (s *InvalidInputException) Message() string { } // OrigErr always returns nil, satisfies awserr.Error interface. -func (s *InvalidInputException) OrigErr() error { +func (s *InvalidNextTokenException) OrigErr() error { return nil } -func (s *InvalidInputException) Error() string { +func (s *InvalidNextTokenException) Error() string { return fmt.Sprintf("%s: %s", s.Code(), s.Message()) } // Status code returns the HTTP status code for the request's response error. -func (s *InvalidInputException) StatusCode() int { +func (s *InvalidNextTokenException) StatusCode() int { return s.RespMetadata.StatusCode } // RequestID returns the service's response RequestID for request. -func (s *InvalidInputException) RequestID() string { +func (s *InvalidNextTokenException) RequestID() string { return s.RespMetadata.RequestID } -// The token is not valid. Tokens expire after 24 hours. -type InvalidNextTokenException struct { +// The limit on the number of resources per account has been exceeded. +type LimitExceededException struct { _ struct{} `type:"structure"` RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` @@ -9014,7 +12269,7 @@ type InvalidNextTokenException struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s InvalidNextTokenException) String() string { +func (s LimitExceededException) String() string { return awsutil.Prettify(s) } @@ -9023,23 +12278,23 @@ func (s InvalidNextTokenException) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s InvalidNextTokenException) GoString() string { +func (s LimitExceededException) GoString() string { return s.String() } -func newErrorInvalidNextTokenException(v protocol.ResponseMetadata) error { - return &InvalidNextTokenException{ +func newErrorLimitExceededException(v protocol.ResponseMetadata) error { + return &LimitExceededException{ RespMetadata: v, } } // Code returns the exception type name. -func (s *InvalidNextTokenException) Code() string { - return "InvalidNextTokenException" +func (s *LimitExceededException) Code() string { + return "LimitExceededException" } // Message returns the exception's message. -func (s *InvalidNextTokenException) Message() string { +func (s *LimitExceededException) Message() string { if s.Message_ != nil { return *s.Message_ } @@ -9047,30 +12302,228 @@ func (s *InvalidNextTokenException) Message() string { } // OrigErr always returns nil, satisfies awserr.Error interface. -func (s *InvalidNextTokenException) OrigErr() error { +func (s *LimitExceededException) OrigErr() error { + return nil +} + +func (s *LimitExceededException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *LimitExceededException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *LimitExceededException) RequestID() string { + return s.RespMetadata.RequestID +} + +type ListDatasetGroupsInput struct { + _ struct{} `type:"structure"` + + // The number of items to return in the response. + MaxResults *int64 `min:"1" type:"integer"` + + // If the result of the previous request was truncated, the response includes + // a NextToken. To retrieve the next set of results, use the token in the next + // request. Tokens expire after 24 hours. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDatasetGroupsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDatasetGroupsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListDatasetGroupsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDatasetGroupsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListDatasetGroupsInput) SetMaxResults(v int64) *ListDatasetGroupsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDatasetGroupsInput) SetNextToken(v string) *ListDatasetGroupsInput { + s.NextToken = &v + return s +} + +type ListDatasetGroupsOutput struct { + _ struct{} `type:"structure"` + + // An array of objects that summarize each dataset group's properties. + DatasetGroups []*DatasetGroupSummary `type:"list"` + + // If the response is truncated, Amazon Forecast returns this token. To retrieve + // the next set of results, use the token in the next request. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDatasetGroupsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDatasetGroupsOutput) GoString() string { + return s.String() +} + +// SetDatasetGroups sets the DatasetGroups field's value. +func (s *ListDatasetGroupsOutput) SetDatasetGroups(v []*DatasetGroupSummary) *ListDatasetGroupsOutput { + s.DatasetGroups = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDatasetGroupsOutput) SetNextToken(v string) *ListDatasetGroupsOutput { + s.NextToken = &v + return s +} + +type ListDatasetImportJobsInput struct { + _ struct{} `type:"structure"` + + // An array of filters. For each filter, you provide a condition and a match + // statement. The condition is either IS or IS_NOT, which specifies whether + // to include or exclude the datasets that match the statement from the list, + // respectively. The match statement consists of a key and a value. + // + // Filter properties + // + // * Condition - The condition to apply. Valid values are IS and IS_NOT. + // To include the datasets that match the statement, specify IS. To exclude + // matching datasets, specify IS_NOT. + // + // * Key - The name of the parameter to filter on. Valid values are DatasetArn + // and Status. + // + // * Value - The value to match. + // + // For example, to list all dataset import jobs whose status is ACTIVE, you + // specify the following filter: + // + // "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ] + Filters []*Filter `type:"list"` + + // The number of items to return in the response. + MaxResults *int64 `min:"1" type:"integer"` + + // If the result of the previous request was truncated, the response includes + // a NextToken. To retrieve the next set of results, use the token in the next + // request. Tokens expire after 24 hours. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDatasetImportJobsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDatasetImportJobsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListDatasetImportJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDatasetImportJobsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.Filters != nil { + for i, v := range s.Filters { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } return nil } -func (s *InvalidNextTokenException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// SetFilters sets the Filters field's value. +func (s *ListDatasetImportJobsInput) SetFilters(v []*Filter) *ListDatasetImportJobsInput { + s.Filters = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListDatasetImportJobsInput) SetMaxResults(v int64) *ListDatasetImportJobsInput { + s.MaxResults = &v + return s } -// Status code returns the HTTP status code for the request's response error. -func (s *InvalidNextTokenException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetNextToken sets the NextToken field's value. +func (s *ListDatasetImportJobsInput) SetNextToken(v string) *ListDatasetImportJobsInput { + s.NextToken = &v + return s } -// RequestID returns the service's response RequestID for request. -func (s *InvalidNextTokenException) RequestID() string { - return s.RespMetadata.RequestID -} +type ListDatasetImportJobsOutput struct { + _ struct{} `type:"structure"` -// The limit on the number of resources per account has been exceeded. -type LimitExceededException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + // An array of objects that summarize each dataset import job's properties. + DatasetImportJobs []*DatasetImportJobSummary `type:"list"` - Message_ *string `locationName:"Message" type:"string"` + // If the response is truncated, Amazon Forecast returns this token. To retrieve + // the next set of results, use the token in the next request. + NextToken *string `min:"1" type:"string"` } // String returns the string representation. @@ -9078,7 +12531,7 @@ type LimitExceededException struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s LimitExceededException) String() string { +func (s ListDatasetImportJobsOutput) String() string { return awsutil.Prettify(s) } @@ -9087,49 +12540,23 @@ func (s LimitExceededException) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s LimitExceededException) GoString() string { +func (s ListDatasetImportJobsOutput) GoString() string { return s.String() } -func newErrorLimitExceededException(v protocol.ResponseMetadata) error { - return &LimitExceededException{ - RespMetadata: v, - } -} - -// Code returns the exception type name. -func (s *LimitExceededException) Code() string { - return "LimitExceededException" -} - -// Message returns the exception's message. -func (s *LimitExceededException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" -} - -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *LimitExceededException) OrigErr() error { - return nil -} - -func (s *LimitExceededException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) -} - -// Status code returns the HTTP status code for the request's response error. -func (s *LimitExceededException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetDatasetImportJobs sets the DatasetImportJobs field's value. +func (s *ListDatasetImportJobsOutput) SetDatasetImportJobs(v []*DatasetImportJobSummary) *ListDatasetImportJobsOutput { + s.DatasetImportJobs = v + return s } -// RequestID returns the service's response RequestID for request. -func (s *LimitExceededException) RequestID() string { - return s.RespMetadata.RequestID +// SetNextToken sets the NextToken field's value. +func (s *ListDatasetImportJobsOutput) SetNextToken(v string) *ListDatasetImportJobsOutput { + s.NextToken = &v + return s } -type ListDatasetGroupsInput struct { +type ListDatasetsInput struct { _ struct{} `type:"structure"` // The number of items to return in the response. @@ -9146,7 +12573,7 @@ type ListDatasetGroupsInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetGroupsInput) String() string { +func (s ListDatasetsInput) String() string { return awsutil.Prettify(s) } @@ -9155,13 +12582,13 @@ func (s ListDatasetGroupsInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetGroupsInput) GoString() string { +func (s ListDatasetsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListDatasetGroupsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListDatasetGroupsInput"} +func (s *ListDatasetsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDatasetsInput"} if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -9176,22 +12603,22 @@ func (s *ListDatasetGroupsInput) Validate() error { } // SetMaxResults sets the MaxResults field's value. -func (s *ListDatasetGroupsInput) SetMaxResults(v int64) *ListDatasetGroupsInput { +func (s *ListDatasetsInput) SetMaxResults(v int64) *ListDatasetsInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListDatasetGroupsInput) SetNextToken(v string) *ListDatasetGroupsInput { +func (s *ListDatasetsInput) SetNextToken(v string) *ListDatasetsInput { s.NextToken = &v return s } -type ListDatasetGroupsOutput struct { +type ListDatasetsOutput struct { _ struct{} `type:"structure"` - // An array of objects that summarize each dataset group's properties. - DatasetGroups []*DatasetGroupSummary `type:"list"` + // An array of objects that summarize each dataset's properties. + Datasets []*DatasetSummary `type:"list"` // If the response is truncated, Amazon Forecast returns this token. To retrieve // the next set of results, use the token in the next request. @@ -9203,7 +12630,7 @@ type ListDatasetGroupsOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetGroupsOutput) String() string { +func (s ListDatasetsOutput) String() string { return awsutil.Prettify(s) } @@ -9212,48 +12639,41 @@ func (s ListDatasetGroupsOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetGroupsOutput) GoString() string { +func (s ListDatasetsOutput) GoString() string { return s.String() } -// SetDatasetGroups sets the DatasetGroups field's value. -func (s *ListDatasetGroupsOutput) SetDatasetGroups(v []*DatasetGroupSummary) *ListDatasetGroupsOutput { - s.DatasetGroups = v +// SetDatasets sets the Datasets field's value. +func (s *ListDatasetsOutput) SetDatasets(v []*DatasetSummary) *ListDatasetsOutput { + s.Datasets = v return s } // SetNextToken sets the NextToken field's value. -func (s *ListDatasetGroupsOutput) SetNextToken(v string) *ListDatasetGroupsOutput { +func (s *ListDatasetsOutput) SetNextToken(v string) *ListDatasetsOutput { s.NextToken = &v return s } -type ListDatasetImportJobsInput struct { +type ListExplainabilitiesInput struct { _ struct{} `type:"structure"` - // An array of filters. For each filter, you provide a condition and a match - // statement. The condition is either IS or IS_NOT, which specifies whether - // to include or exclude the datasets that match the statement from the list, - // respectively. The match statement consists of a key and a value. + // An array of filters. For each filter, provide a condition and a match statement. + // The condition is either IS or IS_NOT, which specifies whether to include + // or exclude the resources that match the statement from the list. The match + // statement consists of a key and a value. // // Filter properties // // * Condition - The condition to apply. Valid values are IS and IS_NOT. - // To include the datasets that match the statement, specify IS. To exclude - // matching datasets, specify IS_NOT. // - // * Key - The name of the parameter to filter on. Valid values are DatasetArn + // * Key - The name of the parameter to filter on. Valid values are PredictorArn // and Status. // // * Value - The value to match. - // - // For example, to list all dataset import jobs whose status is ACTIVE, you - // specify the following filter: - // - // "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ] Filters []*Filter `type:"list"` - // The number of items to return in the response. + // The number of items returned in the response. MaxResults *int64 `min:"1" type:"integer"` // If the result of the previous request was truncated, the response includes @@ -9267,7 +12687,7 @@ type ListDatasetImportJobsInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetImportJobsInput) String() string { +func (s ListExplainabilitiesInput) String() string { return awsutil.Prettify(s) } @@ -9276,13 +12696,13 @@ func (s ListDatasetImportJobsInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetImportJobsInput) GoString() string { +func (s ListExplainabilitiesInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListDatasetImportJobsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListDatasetImportJobsInput"} +func (s *ListExplainabilitiesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListExplainabilitiesInput"} if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } @@ -9307,31 +12727,32 @@ func (s *ListDatasetImportJobsInput) Validate() error { } // SetFilters sets the Filters field's value. -func (s *ListDatasetImportJobsInput) SetFilters(v []*Filter) *ListDatasetImportJobsInput { +func (s *ListExplainabilitiesInput) SetFilters(v []*Filter) *ListExplainabilitiesInput { s.Filters = v return s } // SetMaxResults sets the MaxResults field's value. -func (s *ListDatasetImportJobsInput) SetMaxResults(v int64) *ListDatasetImportJobsInput { +func (s *ListExplainabilitiesInput) SetMaxResults(v int64) *ListExplainabilitiesInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListDatasetImportJobsInput) SetNextToken(v string) *ListDatasetImportJobsInput { +func (s *ListExplainabilitiesInput) SetNextToken(v string) *ListExplainabilitiesInput { s.NextToken = &v return s } -type ListDatasetImportJobsOutput struct { +type ListExplainabilitiesOutput struct { _ struct{} `type:"structure"` - // An array of objects that summarize each dataset import job's properties. - DatasetImportJobs []*DatasetImportJobSummary `type:"list"` + // An array of objects that summarize the properties of each Explainability + // resource. + Explainabilities []*ExplainabilitySummary `type:"list"` - // If the response is truncated, Amazon Forecast returns this token. To retrieve - // the next set of results, use the token in the next request. + // Returns this token if the response is truncated. To retrieve the next set + // of results, use the token in the next request. NextToken *string `min:"1" type:"string"` } @@ -9340,7 +12761,7 @@ type ListDatasetImportJobsOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetImportJobsOutput) String() string { +func (s ListExplainabilitiesOutput) String() string { return awsutil.Prettify(s) } @@ -9349,25 +12770,40 @@ func (s ListDatasetImportJobsOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetImportJobsOutput) GoString() string { +func (s ListExplainabilitiesOutput) GoString() string { return s.String() } -// SetDatasetImportJobs sets the DatasetImportJobs field's value. -func (s *ListDatasetImportJobsOutput) SetDatasetImportJobs(v []*DatasetImportJobSummary) *ListDatasetImportJobsOutput { - s.DatasetImportJobs = v +// SetExplainabilities sets the Explainabilities field's value. +func (s *ListExplainabilitiesOutput) SetExplainabilities(v []*ExplainabilitySummary) *ListExplainabilitiesOutput { + s.Explainabilities = v return s } // SetNextToken sets the NextToken field's value. -func (s *ListDatasetImportJobsOutput) SetNextToken(v string) *ListDatasetImportJobsOutput { +func (s *ListExplainabilitiesOutput) SetNextToken(v string) *ListExplainabilitiesOutput { s.NextToken = &v return s } -type ListDatasetsInput struct { +type ListExplainabilityExportsInput struct { _ struct{} `type:"structure"` + // An array of filters. For each filter, provide a condition and a match statement. + // The condition is either IS or IS_NOT, which specifies whether to include + // or exclude resources that match the statement from the list. The match statement + // consists of a key and a value. + // + // Filter properties + // + // * Condition - The condition to apply. Valid values are IS and IS_NOT. + // + // * Key - The name of the parameter to filter on. Valid values are PredictorArn + // and Status. + // + // * Value - The value to match. + Filters []*Filter `type:"list"` + // The number of items to return in the response. MaxResults *int64 `min:"1" type:"integer"` @@ -9382,7 +12818,7 @@ type ListDatasetsInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetsInput) String() string { +func (s ListExplainabilityExportsInput) String() string { return awsutil.Prettify(s) } @@ -9391,19 +12827,29 @@ func (s ListDatasetsInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetsInput) GoString() string { +func (s ListExplainabilityExportsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListDatasetsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListDatasetsInput"} +func (s *ListExplainabilityExportsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListExplainabilityExportsInput"} if s.MaxResults != nil && *s.MaxResults < 1 { invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } if s.NextToken != nil && len(*s.NextToken) < 1 { invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } + if s.Filters != nil { + for i, v := range s.Filters { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -9411,26 +12857,33 @@ func (s *ListDatasetsInput) Validate() error { return nil } +// SetFilters sets the Filters field's value. +func (s *ListExplainabilityExportsInput) SetFilters(v []*Filter) *ListExplainabilityExportsInput { + s.Filters = v + return s +} + // SetMaxResults sets the MaxResults field's value. -func (s *ListDatasetsInput) SetMaxResults(v int64) *ListDatasetsInput { +func (s *ListExplainabilityExportsInput) SetMaxResults(v int64) *ListExplainabilityExportsInput { s.MaxResults = &v return s } // SetNextToken sets the NextToken field's value. -func (s *ListDatasetsInput) SetNextToken(v string) *ListDatasetsInput { +func (s *ListExplainabilityExportsInput) SetNextToken(v string) *ListExplainabilityExportsInput { s.NextToken = &v return s } -type ListDatasetsOutput struct { +type ListExplainabilityExportsOutput struct { _ struct{} `type:"structure"` - // An array of objects that summarize each dataset's properties. - Datasets []*DatasetSummary `type:"list"` + // An array of objects that summarize the properties of each Explainability + // export. + ExplainabilityExports []*ExplainabilityExportSummary `type:"list"` - // If the response is truncated, Amazon Forecast returns this token. To retrieve - // the next set of results, use the token in the next request. + // Returns this token if the response is truncated. To retrieve the next set + // of results, use the token in the next request. NextToken *string `min:"1" type:"string"` } @@ -9439,7 +12892,7 @@ type ListDatasetsOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetsOutput) String() string { +func (s ListExplainabilityExportsOutput) String() string { return awsutil.Prettify(s) } @@ -9448,18 +12901,18 @@ func (s ListDatasetsOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListDatasetsOutput) GoString() string { +func (s ListExplainabilityExportsOutput) GoString() string { return s.String() } -// SetDatasets sets the Datasets field's value. -func (s *ListDatasetsOutput) SetDatasets(v []*DatasetSummary) *ListDatasetsOutput { - s.Datasets = v +// SetExplainabilityExports sets the ExplainabilityExports field's value. +func (s *ListExplainabilityExportsOutput) SetExplainabilityExports(v []*ExplainabilityExportSummary) *ListExplainabilityExportsOutput { + s.ExplainabilityExports = v return s } // SetNextToken sets the NextToken field's value. -func (s *ListDatasetsOutput) SetNextToken(v string) *ListDatasetsOutput { +func (s *ListExplainabilityExportsOutput) SetNextToken(v string) *ListExplainabilityExportsOutput { s.NextToken = &v return s } @@ -10460,6 +13913,9 @@ type PredictorSummary struct { // used to train the predictor. DatasetGroupArn *string `type:"string"` + // Whether AutoPredictor was used to create the predictor. + IsAutoPredictor *bool `type:"boolean"` + // The last time the resource was modified. The timestamp depends on the status // of the job: // @@ -10483,6 +13939,10 @@ type PredictorSummary struct { // The name of the predictor. PredictorName *string `min:"1" type:"string"` + // A summary of the reference predictor used if the predictor was retrained + // or upgraded. + ReferencePredictorSummary *ReferencePredictorSummary `type:"structure"` + // The status of the predictor. States include: // // * ACTIVE @@ -10528,6 +13988,12 @@ func (s *PredictorSummary) SetDatasetGroupArn(v string) *PredictorSummary { return s } +// SetIsAutoPredictor sets the IsAutoPredictor field's value. +func (s *PredictorSummary) SetIsAutoPredictor(v bool) *PredictorSummary { + s.IsAutoPredictor = &v + return s +} + // SetLastModificationTime sets the LastModificationTime field's value. func (s *PredictorSummary) SetLastModificationTime(v time.Time) *PredictorSummary { s.LastModificationTime = &v @@ -10552,12 +14018,60 @@ func (s *PredictorSummary) SetPredictorName(v string) *PredictorSummary { return s } +// SetReferencePredictorSummary sets the ReferencePredictorSummary field's value. +func (s *PredictorSummary) SetReferencePredictorSummary(v *ReferencePredictorSummary) *PredictorSummary { + s.ReferencePredictorSummary = v + return s +} + // SetStatus sets the Status field's value. func (s *PredictorSummary) SetStatus(v string) *PredictorSummary { s.Status = &v return s } +// Provides a summary of the reference predictor used when retraining or upgrading +// a predictor. +type ReferencePredictorSummary struct { + _ struct{} `type:"structure"` + + // The ARN of the reference predictor. + Arn *string `type:"string"` + + // Whether the reference predictor is Active or Deleted. + State *string `type:"string" enum:"State"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ReferencePredictorSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ReferencePredictorSummary) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *ReferencePredictorSummary) SetArn(v string) *ReferencePredictorSummary { + s.Arn = &v + return s +} + +// SetState sets the State field's value. +func (s *ReferencePredictorSummary) SetState(v string) *ReferencePredictorSummary { + s.State = &v + return s +} + // There is already a resource with this name. Try again with a different name. type ResourceAlreadyExistsException struct { _ struct{} `type:"structure"` @@ -10766,7 +14280,7 @@ type S3Config struct { // in an Amazon S3 bucket. // // Path is a required field - Path *string `type:"string" required:"true"` + Path *string `min:"7" type:"string" required:"true"` // The ARN of the AWS Identity and Access Management (IAM) role that Amazon // Forecast can assume to access the Amazon S3 bucket or files. If you provide @@ -10803,6 +14317,9 @@ func (s *S3Config) Validate() error { if s.Path == nil { invalidParams.Add(request.NewErrParamRequired("Path")) } + if s.Path != nil && len(*s.Path) < 7 { + invalidParams.Add(request.NewErrParamMinLen("Path", 7)) + } if s.RoleArn == nil { invalidParams.Add(request.NewErrParamRequired("RoleArn")) } @@ -11982,12 +15499,16 @@ func AttributeType_Values() []string { const ( // AutoMLOverrideStrategyLatencyOptimized is a AutoMLOverrideStrategy enum value AutoMLOverrideStrategyLatencyOptimized = "LatencyOptimized" + + // AutoMLOverrideStrategyAccuracyOptimized is a AutoMLOverrideStrategy enum value + AutoMLOverrideStrategyAccuracyOptimized = "AccuracyOptimized" ) // AutoMLOverrideStrategy_Values returns all elements of the AutoMLOverrideStrategy enum func AutoMLOverrideStrategy_Values() []string { return []string{ AutoMLOverrideStrategyLatencyOptimized, + AutoMLOverrideStrategyAccuracyOptimized, } } @@ -12142,3 +15663,51 @@ func ScalingType_Values() []string { ScalingTypeReverseLogarithmic, } } + +const ( + // StateActive is a State enum value + StateActive = "Active" + + // StateDeleted is a State enum value + StateDeleted = "Deleted" +) + +// State_Values returns all elements of the State enum +func State_Values() []string { + return []string{ + StateActive, + StateDeleted, + } +} + +const ( + // TimePointGranularityAll is a TimePointGranularity enum value + TimePointGranularityAll = "ALL" + + // TimePointGranularitySpecific is a TimePointGranularity enum value + TimePointGranularitySpecific = "SPECIFIC" +) + +// TimePointGranularity_Values returns all elements of the TimePointGranularity enum +func TimePointGranularity_Values() []string { + return []string{ + TimePointGranularityAll, + TimePointGranularitySpecific, + } +} + +const ( + // TimeSeriesGranularityAll is a TimeSeriesGranularity enum value + TimeSeriesGranularityAll = "ALL" + + // TimeSeriesGranularitySpecific is a TimeSeriesGranularity enum value + TimeSeriesGranularitySpecific = "SPECIFIC" +) + +// TimeSeriesGranularity_Values returns all elements of the TimeSeriesGranularity enum +func TimeSeriesGranularity_Values() []string { + return []string{ + TimeSeriesGranularityAll, + TimeSeriesGranularitySpecific, + } +} diff --git a/service/forecastservice/forecastserviceiface/interface.go b/service/forecastservice/forecastserviceiface/interface.go index 8b1f239cae..3f9a33900b 100644 --- a/service/forecastservice/forecastserviceiface/interface.go +++ b/service/forecastservice/forecastserviceiface/interface.go @@ -26,7 +26,7 @@ import ( // // myFunc uses an SDK service client to make a request to // // Amazon Forecast Service. // func myFunc(svc forecastserviceiface.ForecastServiceAPI) bool { -// // Make svc.CreateDataset request +// // Make svc.CreateAutoPredictor request // } // // func main() { @@ -42,7 +42,7 @@ import ( // type mockForecastServiceClient struct { // forecastserviceiface.ForecastServiceAPI // } -// func (m *mockForecastServiceClient) CreateDataset(input *forecastservice.CreateDatasetInput) (*forecastservice.CreateDatasetOutput, error) { +// func (m *mockForecastServiceClient) CreateAutoPredictor(input *forecastservice.CreateAutoPredictorInput) (*forecastservice.CreateAutoPredictorOutput, error) { // // mock response/functionality // } // @@ -60,6 +60,10 @@ import ( // and waiters. Its suggested to use the pattern above for testing, or using // tooling to generate mocks to satisfy the interfaces. type ForecastServiceAPI interface { + CreateAutoPredictor(*forecastservice.CreateAutoPredictorInput) (*forecastservice.CreateAutoPredictorOutput, error) + CreateAutoPredictorWithContext(aws.Context, *forecastservice.CreateAutoPredictorInput, ...request.Option) (*forecastservice.CreateAutoPredictorOutput, error) + CreateAutoPredictorRequest(*forecastservice.CreateAutoPredictorInput) (*request.Request, *forecastservice.CreateAutoPredictorOutput) + CreateDataset(*forecastservice.CreateDatasetInput) (*forecastservice.CreateDatasetOutput, error) CreateDatasetWithContext(aws.Context, *forecastservice.CreateDatasetInput, ...request.Option) (*forecastservice.CreateDatasetOutput, error) CreateDatasetRequest(*forecastservice.CreateDatasetInput) (*request.Request, *forecastservice.CreateDatasetOutput) @@ -72,6 +76,14 @@ type ForecastServiceAPI interface { CreateDatasetImportJobWithContext(aws.Context, *forecastservice.CreateDatasetImportJobInput, ...request.Option) (*forecastservice.CreateDatasetImportJobOutput, error) CreateDatasetImportJobRequest(*forecastservice.CreateDatasetImportJobInput) (*request.Request, *forecastservice.CreateDatasetImportJobOutput) + CreateExplainability(*forecastservice.CreateExplainabilityInput) (*forecastservice.CreateExplainabilityOutput, error) + CreateExplainabilityWithContext(aws.Context, *forecastservice.CreateExplainabilityInput, ...request.Option) (*forecastservice.CreateExplainabilityOutput, error) + CreateExplainabilityRequest(*forecastservice.CreateExplainabilityInput) (*request.Request, *forecastservice.CreateExplainabilityOutput) + + CreateExplainabilityExport(*forecastservice.CreateExplainabilityExportInput) (*forecastservice.CreateExplainabilityExportOutput, error) + CreateExplainabilityExportWithContext(aws.Context, *forecastservice.CreateExplainabilityExportInput, ...request.Option) (*forecastservice.CreateExplainabilityExportOutput, error) + CreateExplainabilityExportRequest(*forecastservice.CreateExplainabilityExportInput) (*request.Request, *forecastservice.CreateExplainabilityExportOutput) + CreateForecast(*forecastservice.CreateForecastInput) (*forecastservice.CreateForecastOutput, error) CreateForecastWithContext(aws.Context, *forecastservice.CreateForecastInput, ...request.Option) (*forecastservice.CreateForecastOutput, error) CreateForecastRequest(*forecastservice.CreateForecastInput) (*request.Request, *forecastservice.CreateForecastOutput) @@ -100,6 +112,14 @@ type ForecastServiceAPI interface { DeleteDatasetImportJobWithContext(aws.Context, *forecastservice.DeleteDatasetImportJobInput, ...request.Option) (*forecastservice.DeleteDatasetImportJobOutput, error) DeleteDatasetImportJobRequest(*forecastservice.DeleteDatasetImportJobInput) (*request.Request, *forecastservice.DeleteDatasetImportJobOutput) + DeleteExplainability(*forecastservice.DeleteExplainabilityInput) (*forecastservice.DeleteExplainabilityOutput, error) + DeleteExplainabilityWithContext(aws.Context, *forecastservice.DeleteExplainabilityInput, ...request.Option) (*forecastservice.DeleteExplainabilityOutput, error) + DeleteExplainabilityRequest(*forecastservice.DeleteExplainabilityInput) (*request.Request, *forecastservice.DeleteExplainabilityOutput) + + DeleteExplainabilityExport(*forecastservice.DeleteExplainabilityExportInput) (*forecastservice.DeleteExplainabilityExportOutput, error) + DeleteExplainabilityExportWithContext(aws.Context, *forecastservice.DeleteExplainabilityExportInput, ...request.Option) (*forecastservice.DeleteExplainabilityExportOutput, error) + DeleteExplainabilityExportRequest(*forecastservice.DeleteExplainabilityExportInput) (*request.Request, *forecastservice.DeleteExplainabilityExportOutput) + DeleteForecast(*forecastservice.DeleteForecastInput) (*forecastservice.DeleteForecastOutput, error) DeleteForecastWithContext(aws.Context, *forecastservice.DeleteForecastInput, ...request.Option) (*forecastservice.DeleteForecastOutput, error) DeleteForecastRequest(*forecastservice.DeleteForecastInput) (*request.Request, *forecastservice.DeleteForecastOutput) @@ -120,6 +140,10 @@ type ForecastServiceAPI interface { DeleteResourceTreeWithContext(aws.Context, *forecastservice.DeleteResourceTreeInput, ...request.Option) (*forecastservice.DeleteResourceTreeOutput, error) DeleteResourceTreeRequest(*forecastservice.DeleteResourceTreeInput) (*request.Request, *forecastservice.DeleteResourceTreeOutput) + DescribeAutoPredictor(*forecastservice.DescribeAutoPredictorInput) (*forecastservice.DescribeAutoPredictorOutput, error) + DescribeAutoPredictorWithContext(aws.Context, *forecastservice.DescribeAutoPredictorInput, ...request.Option) (*forecastservice.DescribeAutoPredictorOutput, error) + DescribeAutoPredictorRequest(*forecastservice.DescribeAutoPredictorInput) (*request.Request, *forecastservice.DescribeAutoPredictorOutput) + DescribeDataset(*forecastservice.DescribeDatasetInput) (*forecastservice.DescribeDatasetOutput, error) DescribeDatasetWithContext(aws.Context, *forecastservice.DescribeDatasetInput, ...request.Option) (*forecastservice.DescribeDatasetOutput, error) DescribeDatasetRequest(*forecastservice.DescribeDatasetInput) (*request.Request, *forecastservice.DescribeDatasetOutput) @@ -132,6 +156,14 @@ type ForecastServiceAPI interface { DescribeDatasetImportJobWithContext(aws.Context, *forecastservice.DescribeDatasetImportJobInput, ...request.Option) (*forecastservice.DescribeDatasetImportJobOutput, error) DescribeDatasetImportJobRequest(*forecastservice.DescribeDatasetImportJobInput) (*request.Request, *forecastservice.DescribeDatasetImportJobOutput) + DescribeExplainability(*forecastservice.DescribeExplainabilityInput) (*forecastservice.DescribeExplainabilityOutput, error) + DescribeExplainabilityWithContext(aws.Context, *forecastservice.DescribeExplainabilityInput, ...request.Option) (*forecastservice.DescribeExplainabilityOutput, error) + DescribeExplainabilityRequest(*forecastservice.DescribeExplainabilityInput) (*request.Request, *forecastservice.DescribeExplainabilityOutput) + + DescribeExplainabilityExport(*forecastservice.DescribeExplainabilityExportInput) (*forecastservice.DescribeExplainabilityExportOutput, error) + DescribeExplainabilityExportWithContext(aws.Context, *forecastservice.DescribeExplainabilityExportInput, ...request.Option) (*forecastservice.DescribeExplainabilityExportOutput, error) + DescribeExplainabilityExportRequest(*forecastservice.DescribeExplainabilityExportInput) (*request.Request, *forecastservice.DescribeExplainabilityExportOutput) + DescribeForecast(*forecastservice.DescribeForecastInput) (*forecastservice.DescribeForecastOutput, error) DescribeForecastWithContext(aws.Context, *forecastservice.DescribeForecastInput, ...request.Option) (*forecastservice.DescribeForecastOutput, error) DescribeForecastRequest(*forecastservice.DescribeForecastInput) (*request.Request, *forecastservice.DescribeForecastOutput) @@ -173,6 +205,14 @@ type ForecastServiceAPI interface { ListDatasetsPages(*forecastservice.ListDatasetsInput, func(*forecastservice.ListDatasetsOutput, bool) bool) error ListDatasetsPagesWithContext(aws.Context, *forecastservice.ListDatasetsInput, func(*forecastservice.ListDatasetsOutput, bool) bool, ...request.Option) error + ListExplainabilities(*forecastservice.ListExplainabilitiesInput) (*forecastservice.ListExplainabilitiesOutput, error) + ListExplainabilitiesWithContext(aws.Context, *forecastservice.ListExplainabilitiesInput, ...request.Option) (*forecastservice.ListExplainabilitiesOutput, error) + ListExplainabilitiesRequest(*forecastservice.ListExplainabilitiesInput) (*request.Request, *forecastservice.ListExplainabilitiesOutput) + + ListExplainabilityExports(*forecastservice.ListExplainabilityExportsInput) (*forecastservice.ListExplainabilityExportsOutput, error) + ListExplainabilityExportsWithContext(aws.Context, *forecastservice.ListExplainabilityExportsInput, ...request.Option) (*forecastservice.ListExplainabilityExportsOutput, error) + ListExplainabilityExportsRequest(*forecastservice.ListExplainabilityExportsInput) (*request.Request, *forecastservice.ListExplainabilityExportsOutput) + ListForecastExportJobs(*forecastservice.ListForecastExportJobsInput) (*forecastservice.ListForecastExportJobsOutput, error) ListForecastExportJobsWithContext(aws.Context, *forecastservice.ListForecastExportJobsInput, ...request.Option) (*forecastservice.ListForecastExportJobsOutput, error) ListForecastExportJobsRequest(*forecastservice.ListForecastExportJobsInput) (*request.Request, *forecastservice.ListForecastExportJobsOutput) diff --git a/service/gluedatabrew/api.go b/service/gluedatabrew/api.go index 6d3a2fe3bb..1e58f7b926 100644 --- a/service/gluedatabrew/api.go +++ b/service/gluedatabrew/api.go @@ -569,6 +569,92 @@ func (c *GlueDataBrew) CreateRecipeJobWithContext(ctx aws.Context, input *Create return out, req.Send() } +const opCreateRuleset = "CreateRuleset" + +// CreateRulesetRequest generates a "aws/request.Request" representing the +// client's request for the CreateRuleset operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateRuleset for more information on using the CreateRuleset +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateRulesetRequest method. +// req, resp := client.CreateRulesetRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateRuleset +func (c *GlueDataBrew) CreateRulesetRequest(input *CreateRulesetInput) (req *request.Request, output *CreateRulesetOutput) { + op := &request.Operation{ + Name: opCreateRuleset, + HTTPMethod: "POST", + HTTPPath: "/rulesets", + } + + if input == nil { + input = &CreateRulesetInput{} + } + + output = &CreateRulesetOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateRuleset API operation for AWS Glue DataBrew. +// +// Creates a new ruleset that can be used in a profile job to validate the data +// quality of a dataset. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Glue DataBrew's +// API operation CreateRuleset for usage and error information. +// +// Returned Error Types: +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// * ServiceQuotaExceededException +// A service quota is exceeded. +// +// * ValidationException +// The input parameters for this request failed validation. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/CreateRuleset +func (c *GlueDataBrew) CreateRuleset(input *CreateRulesetInput) (*CreateRulesetOutput, error) { + req, out := c.CreateRulesetRequest(input) + return out, req.Send() +} + +// CreateRulesetWithContext is the same as CreateRuleset with the addition of +// the ability to pass a context and additional request options. +// +// See CreateRuleset for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GlueDataBrew) CreateRulesetWithContext(ctx aws.Context, input *CreateRulesetInput, opts ...request.Option) (*CreateRulesetOutput, error) { + req, out := c.CreateRulesetRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opCreateSchedule = "CreateSchedule" // CreateScheduleRequest generates a "aws/request.Request" representing the @@ -995,6 +1081,91 @@ func (c *GlueDataBrew) DeleteRecipeVersionWithContext(ctx aws.Context, input *De return out, req.Send() } +const opDeleteRuleset = "DeleteRuleset" + +// DeleteRulesetRequest generates a "aws/request.Request" representing the +// client's request for the DeleteRuleset operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteRuleset for more information on using the DeleteRuleset +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteRulesetRequest method. +// req, resp := client.DeleteRulesetRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteRuleset +func (c *GlueDataBrew) DeleteRulesetRequest(input *DeleteRulesetInput) (req *request.Request, output *DeleteRulesetOutput) { + op := &request.Operation{ + Name: opDeleteRuleset, + HTTPMethod: "DELETE", + HTTPPath: "/rulesets/{name}", + } + + if input == nil { + input = &DeleteRulesetInput{} + } + + output = &DeleteRulesetOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteRuleset API operation for AWS Glue DataBrew. +// +// Deletes a ruleset. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Glue DataBrew's +// API operation DeleteRuleset for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ValidationException +// The input parameters for this request failed validation. +// +// * ConflictException +// Updating or deleting a resource can cause an inconsistent state. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DeleteRuleset +func (c *GlueDataBrew) DeleteRuleset(input *DeleteRulesetInput) (*DeleteRulesetOutput, error) { + req, out := c.DeleteRulesetRequest(input) + return out, req.Send() +} + +// DeleteRulesetWithContext is the same as DeleteRuleset with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteRuleset for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GlueDataBrew) DeleteRulesetWithContext(ctx aws.Context, input *DeleteRulesetInput, opts ...request.Option) (*DeleteRulesetOutput, error) { + req, out := c.DeleteRulesetRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteSchedule = "DeleteSchedule" // DeleteScheduleRequest generates a "aws/request.Request" representing the @@ -1488,6 +1659,88 @@ func (c *GlueDataBrew) DescribeRecipeWithContext(ctx aws.Context, input *Describ return out, req.Send() } +const opDescribeRuleset = "DescribeRuleset" + +// DescribeRulesetRequest generates a "aws/request.Request" representing the +// client's request for the DescribeRuleset operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeRuleset for more information on using the DescribeRuleset +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeRulesetRequest method. +// req, resp := client.DescribeRulesetRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeRuleset +func (c *GlueDataBrew) DescribeRulesetRequest(input *DescribeRulesetInput) (req *request.Request, output *DescribeRulesetOutput) { + op := &request.Operation{ + Name: opDescribeRuleset, + HTTPMethod: "GET", + HTTPPath: "/rulesets/{name}", + } + + if input == nil { + input = &DescribeRulesetInput{} + } + + output = &DescribeRulesetOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeRuleset API operation for AWS Glue DataBrew. +// +// Retrieves detailed information about the ruleset. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Glue DataBrew's +// API operation DescribeRuleset for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ValidationException +// The input parameters for this request failed validation. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/DescribeRuleset +func (c *GlueDataBrew) DescribeRuleset(input *DescribeRulesetInput) (*DescribeRulesetOutput, error) { + req, out := c.DescribeRulesetRequest(input) + return out, req.Send() +} + +// DescribeRulesetWithContext is the same as DescribeRuleset with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeRuleset for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GlueDataBrew) DescribeRulesetWithContext(ctx aws.Context, input *DescribeRulesetInput, opts ...request.Option) (*DescribeRulesetOutput, error) { + req, out := c.DescribeRulesetRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeSchedule = "DescribeSchedule" // DescribeScheduleRequest generates a "aws/request.Request" representing the @@ -2395,37 +2648,37 @@ func (c *GlueDataBrew) ListRecipesPagesWithContext(ctx aws.Context, input *ListR return p.Err() } -const opListSchedules = "ListSchedules" +const opListRulesets = "ListRulesets" -// ListSchedulesRequest generates a "aws/request.Request" representing the -// client's request for the ListSchedules operation. The "output" return +// ListRulesetsRequest generates a "aws/request.Request" representing the +// client's request for the ListRulesets operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListSchedules for more information on using the ListSchedules +// See ListRulesets for more information on using the ListRulesets // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the ListSchedulesRequest method. -// req, resp := client.ListSchedulesRequest(params) +// // Example sending a request using the ListRulesetsRequest method. +// req, resp := client.ListRulesetsRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListSchedules -func (c *GlueDataBrew) ListSchedulesRequest(input *ListSchedulesInput) (req *request.Request, output *ListSchedulesOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListRulesets +func (c *GlueDataBrew) ListRulesetsRequest(input *ListRulesetsInput) (req *request.Request, output *ListRulesetsOutput) { op := &request.Operation{ - Name: opListSchedules, + Name: opListRulesets, HTTPMethod: "GET", - HTTPPath: "/schedules", + HTTPPath: "/rulesets", Paginator: &request.Paginator{ InputTokens: []string{"NextToken"}, OutputTokens: []string{"NextToken"}, @@ -2435,88 +2688,92 @@ func (c *GlueDataBrew) ListSchedulesRequest(input *ListSchedulesInput) (req *req } if input == nil { - input = &ListSchedulesInput{} + input = &ListRulesetsInput{} } - output = &ListSchedulesOutput{} + output = &ListRulesetsOutput{} req = c.newRequest(op, input, output) return } -// ListSchedules API operation for AWS Glue DataBrew. +// ListRulesets API operation for AWS Glue DataBrew. // -// Lists the DataBrew schedules that are defined. +// List all rulesets available in the current account or rulesets associated +// with a specific resource (dataset). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. // // See the AWS API reference guide for AWS Glue DataBrew's -// API operation ListSchedules for usage and error information. +// API operation ListRulesets for usage and error information. // // Returned Error Types: +// * ResourceNotFoundException +// One or more resources can't be found. +// // * ValidationException // The input parameters for this request failed validation. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListSchedules -func (c *GlueDataBrew) ListSchedules(input *ListSchedulesInput) (*ListSchedulesOutput, error) { - req, out := c.ListSchedulesRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListRulesets +func (c *GlueDataBrew) ListRulesets(input *ListRulesetsInput) (*ListRulesetsOutput, error) { + req, out := c.ListRulesetsRequest(input) return out, req.Send() } -// ListSchedulesWithContext is the same as ListSchedules with the addition of +// ListRulesetsWithContext is the same as ListRulesets with the addition of // the ability to pass a context and additional request options. // -// See ListSchedules for details on how to use this API operation. +// See ListRulesets for details on how to use this API operation. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *GlueDataBrew) ListSchedulesWithContext(ctx aws.Context, input *ListSchedulesInput, opts ...request.Option) (*ListSchedulesOutput, error) { - req, out := c.ListSchedulesRequest(input) +func (c *GlueDataBrew) ListRulesetsWithContext(ctx aws.Context, input *ListRulesetsInput, opts ...request.Option) (*ListRulesetsOutput, error) { + req, out := c.ListRulesetsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -// ListSchedulesPages iterates over the pages of a ListSchedules operation, +// ListRulesetsPages iterates over the pages of a ListRulesets operation, // calling the "fn" function with the response data for each page. To stop // iterating, return false from the fn function. // -// See ListSchedules method for more information on how to use this operation. +// See ListRulesets method for more information on how to use this operation. // // Note: This operation can generate multiple requests to a service. // -// // Example iterating over at most 3 pages of a ListSchedules operation. +// // Example iterating over at most 3 pages of a ListRulesets operation. // pageNum := 0 -// err := client.ListSchedulesPages(params, -// func(page *gluedatabrew.ListSchedulesOutput, lastPage bool) bool { +// err := client.ListRulesetsPages(params, +// func(page *gluedatabrew.ListRulesetsOutput, lastPage bool) bool { // pageNum++ // fmt.Println(page) // return pageNum <= 3 // }) // -func (c *GlueDataBrew) ListSchedulesPages(input *ListSchedulesInput, fn func(*ListSchedulesOutput, bool) bool) error { - return c.ListSchedulesPagesWithContext(aws.BackgroundContext(), input, fn) +func (c *GlueDataBrew) ListRulesetsPages(input *ListRulesetsInput, fn func(*ListRulesetsOutput, bool) bool) error { + return c.ListRulesetsPagesWithContext(aws.BackgroundContext(), input, fn) } -// ListSchedulesPagesWithContext same as ListSchedulesPages except +// ListRulesetsPagesWithContext same as ListRulesetsPages except // it takes a Context and allows setting request options on the pages. // // The context must be non-nil and will be used for request cancellation. If // the context is nil a panic will occur. In the future the SDK may create // sub-contexts for http.Requests. See https://golang.org/pkg/context/ // for more information on using Contexts. -func (c *GlueDataBrew) ListSchedulesPagesWithContext(ctx aws.Context, input *ListSchedulesInput, fn func(*ListSchedulesOutput, bool) bool, opts ...request.Option) error { +func (c *GlueDataBrew) ListRulesetsPagesWithContext(ctx aws.Context, input *ListRulesetsInput, fn func(*ListRulesetsOutput, bool) bool, opts ...request.Option) error { p := request.Pagination{ NewRequest: func() (*request.Request, error) { - var inCpy *ListSchedulesInput + var inCpy *ListRulesetsInput if input != nil { tmp := *input inCpy = &tmp } - req, _ := c.ListSchedulesRequest(inCpy) + req, _ := c.ListRulesetsRequest(inCpy) req.SetContext(ctx) req.ApplyOptions(opts...) return req, nil @@ -2524,7 +2781,7 @@ func (c *GlueDataBrew) ListSchedulesPagesWithContext(ctx aws.Context, input *Lis } for p.Next() { - if !fn(p.Page().(*ListSchedulesOutput), !p.HasNextPage()) { + if !fn(p.Page().(*ListRulesetsOutput), !p.HasNextPage()) { break } } @@ -2532,51 +2789,188 @@ func (c *GlueDataBrew) ListSchedulesPagesWithContext(ctx aws.Context, input *Lis return p.Err() } -const opListTagsForResource = "ListTagsForResource" +const opListSchedules = "ListSchedules" -// ListTagsForResourceRequest generates a "aws/request.Request" representing the -// client's request for the ListTagsForResource operation. The "output" return +// ListSchedulesRequest generates a "aws/request.Request" representing the +// client's request for the ListSchedules operation. The "output" return // value will be populated with the request's response once the request completes // successfully. // // Use "Send" method on the returned Request to send the API call to the service. // the "output" return value is not valid until after Send returns without error. // -// See ListTagsForResource for more information on using the ListTagsForResource +// See ListSchedules for more information on using the ListSchedules // API call, and error handling. // // This method is useful when you want to inject custom logic or configuration // into the SDK's request lifecycle. Such as custom headers, or retry logic. // // -// // Example sending a request using the ListTagsForResourceRequest method. -// req, resp := client.ListTagsForResourceRequest(params) +// // Example sending a request using the ListSchedulesRequest method. +// req, resp := client.ListSchedulesRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListTagsForResource -func (c *GlueDataBrew) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListSchedules +func (c *GlueDataBrew) ListSchedulesRequest(input *ListSchedulesInput) (req *request.Request, output *ListSchedulesOutput) { op := &request.Operation{ - Name: opListTagsForResource, + Name: opListSchedules, HTTPMethod: "GET", - HTTPPath: "/tags/{ResourceArn}", + HTTPPath: "/schedules", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } if input == nil { - input = &ListTagsForResourceInput{} + input = &ListSchedulesInput{} } - output = &ListTagsForResourceOutput{} + output = &ListSchedulesOutput{} req = c.newRequest(op, input, output) return } -// ListTagsForResource API operation for AWS Glue DataBrew. +// ListSchedules API operation for AWS Glue DataBrew. // -// Lists all the tags for a DataBrew resource. +// Lists the DataBrew schedules that are defined. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Glue DataBrew's +// API operation ListSchedules for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The input parameters for this request failed validation. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListSchedules +func (c *GlueDataBrew) ListSchedules(input *ListSchedulesInput) (*ListSchedulesOutput, error) { + req, out := c.ListSchedulesRequest(input) + return out, req.Send() +} + +// ListSchedulesWithContext is the same as ListSchedules with the addition of +// the ability to pass a context and additional request options. +// +// See ListSchedules for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GlueDataBrew) ListSchedulesWithContext(ctx aws.Context, input *ListSchedulesInput, opts ...request.Option) (*ListSchedulesOutput, error) { + req, out := c.ListSchedulesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListSchedulesPages iterates over the pages of a ListSchedules operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListSchedules method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListSchedules operation. +// pageNum := 0 +// err := client.ListSchedulesPages(params, +// func(page *gluedatabrew.ListSchedulesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *GlueDataBrew) ListSchedulesPages(input *ListSchedulesInput, fn func(*ListSchedulesOutput, bool) bool) error { + return c.ListSchedulesPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListSchedulesPagesWithContext same as ListSchedulesPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GlueDataBrew) ListSchedulesPagesWithContext(ctx aws.Context, input *ListSchedulesInput, fn func(*ListSchedulesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListSchedulesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListSchedulesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListSchedulesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListTagsForResource for more information on using the ListTagsForResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/ListTagsForResource +func (c *GlueDataBrew) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { + op := &request.Operation{ + Name: opListTagsForResource, + HTTPMethod: "GET", + HTTPPath: "/tags/{ResourceArn}", + } + + if input == nil { + input = &ListTagsForResourceInput{} + } + + output = &ListTagsForResourceOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListTagsForResource API operation for AWS Glue DataBrew. +// +// Lists all the tags for a DataBrew resource. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3639,6 +4033,88 @@ func (c *GlueDataBrew) UpdateRecipeJobWithContext(ctx aws.Context, input *Update return out, req.Send() } +const opUpdateRuleset = "UpdateRuleset" + +// UpdateRulesetRequest generates a "aws/request.Request" representing the +// client's request for the UpdateRuleset operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateRuleset for more information on using the UpdateRuleset +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateRulesetRequest method. +// req, resp := client.UpdateRulesetRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateRuleset +func (c *GlueDataBrew) UpdateRulesetRequest(input *UpdateRulesetInput) (req *request.Request, output *UpdateRulesetOutput) { + op := &request.Operation{ + Name: opUpdateRuleset, + HTTPMethod: "PUT", + HTTPPath: "/rulesets/{name}", + } + + if input == nil { + input = &UpdateRulesetInput{} + } + + output = &UpdateRulesetOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateRuleset API operation for AWS Glue DataBrew. +// +// Updates specified ruleset. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for AWS Glue DataBrew's +// API operation UpdateRuleset for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// One or more resources can't be found. +// +// * ValidationException +// The input parameters for this request failed validation. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/databrew-2017-07-25/UpdateRuleset +func (c *GlueDataBrew) UpdateRuleset(input *UpdateRulesetInput) (*UpdateRulesetOutput, error) { + req, out := c.UpdateRulesetRequest(input) + return out, req.Send() +} + +// UpdateRulesetWithContext is the same as UpdateRuleset with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateRuleset for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *GlueDataBrew) UpdateRulesetWithContext(ctx aws.Context, input *UpdateRulesetInput, opts ...request.Option) (*UpdateRulesetOutput, error) { + req, out := c.UpdateRulesetRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opUpdateSchedule = "UpdateSchedule" // UpdateScheduleRequest generates a "aws/request.Request" representing the @@ -3788,6 +4264,59 @@ func (s *AccessDeniedException) RequestID() string { return s.RespMetadata.RequestID } +// Configuration of statistics that are allowed to be run on columns that contain +// detected entities. When undefined, no statistics will be computed on columns +// that contain detected entities. +type AllowedStatistics struct { + _ struct{} `type:"structure"` + + // One or more column statistics to allow for columns that contain detected + // entities. + // + // Statistics is a required field + Statistics []*string `min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AllowedStatistics) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AllowedStatistics) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *AllowedStatistics) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "AllowedStatistics"} + if s.Statistics == nil { + invalidParams.Add(request.NewErrParamRequired("Statistics")) + } + if s.Statistics != nil && len(s.Statistics) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Statistics", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetStatistics sets the Statistics field's value. +func (s *AllowedStatistics) SetStatistics(v []*string) *AllowedStatistics { + s.Statistics = v + return s +} + type BatchDeleteRecipeVersionInput struct { _ struct{} `type:"structure"` @@ -4403,6 +4932,9 @@ type CreateProfileJobInput struct { // The job's timeout in minutes. A job that attempts to run longer than this // timeout period ends with a status of TIMEOUT. Timeout *int64 `type:"integer"` + + // List of validation configurations that are applied to the profile job. + ValidationConfigurations []*ValidationConfiguration `min:"1" type:"list"` } // String returns the string representation. @@ -4453,6 +4985,9 @@ func (s *CreateProfileJobInput) Validate() error { if s.Tags != nil && len(s.Tags) < 1 { invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) } + if s.ValidationConfigurations != nil && len(s.ValidationConfigurations) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ValidationConfigurations", 1)) + } if s.Configuration != nil { if err := s.Configuration.Validate(); err != nil { invalidParams.AddNested("Configuration", err.(request.ErrInvalidParams)) @@ -4463,6 +4998,16 @@ func (s *CreateProfileJobInput) Validate() error { invalidParams.AddNested("OutputLocation", err.(request.ErrInvalidParams)) } } + if s.ValidationConfigurations != nil { + for i, v := range s.ValidationConfigurations { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ValidationConfigurations", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -4548,6 +5093,12 @@ func (s *CreateProfileJobInput) SetTimeout(v int64) *CreateProfileJobInput { return s } +// SetValidationConfigurations sets the ValidationConfigurations field's value. +func (s *CreateProfileJobInput) SetValidationConfigurations(v []*ValidationConfiguration) *CreateProfileJobInput { + s.ValidationConfigurations = v + return s +} + type CreateProfileJobOutput struct { _ struct{} `type:"structure"` @@ -5158,18 +5709,168 @@ func (s *CreateRecipeOutput) SetName(v string) *CreateRecipeOutput { return s } -type CreateScheduleInput struct { +type CreateRulesetInput struct { _ struct{} `type:"structure"` - // The date or dates and time or times when the jobs are to be run. For more - // information, see Cron expressions (https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) - // in the Glue DataBrew Developer Guide. + // The description of the ruleset. + Description *string `type:"string"` + + // The name of the ruleset to be created. Valid characters are alphanumeric + // (A-Z, a-z, 0-9), hyphen (-), period (.), and space. // - // CronExpression is a required field - CronExpression *string `min:"1" type:"string" required:"true"` + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` - // The name or names of one or more jobs to be run. - JobNames []*string `type:"list"` + // A list of rules that are defined with the ruleset. A rule includes one or + // more checks to be validated on a DataBrew dataset. + // + // Rules is a required field + Rules []*Rule `min:"1" type:"list" required:"true"` + + // Metadata tags to apply to the ruleset. + Tags map[string]*string `min:"1" type:"map"` + + // The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is + // associated with. + // + // TargetArn is a required field + TargetArn *string `min:"20" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRulesetInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRulesetInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateRulesetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateRulesetInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.Rules == nil { + invalidParams.Add(request.NewErrParamRequired("Rules")) + } + if s.Rules != nil && len(s.Rules) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Rules", 1)) + } + if s.Tags != nil && len(s.Tags) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Tags", 1)) + } + if s.TargetArn == nil { + invalidParams.Add(request.NewErrParamRequired("TargetArn")) + } + if s.TargetArn != nil && len(*s.TargetArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("TargetArn", 20)) + } + if s.Rules != nil { + for i, v := range s.Rules { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Rules", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDescription sets the Description field's value. +func (s *CreateRulesetInput) SetDescription(v string) *CreateRulesetInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateRulesetInput) SetName(v string) *CreateRulesetInput { + s.Name = &v + return s +} + +// SetRules sets the Rules field's value. +func (s *CreateRulesetInput) SetRules(v []*Rule) *CreateRulesetInput { + s.Rules = v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateRulesetInput) SetTags(v map[string]*string) *CreateRulesetInput { + s.Tags = v + return s +} + +// SetTargetArn sets the TargetArn field's value. +func (s *CreateRulesetInput) SetTargetArn(v string) *CreateRulesetInput { + s.TargetArn = &v + return s +} + +type CreateRulesetOutput struct { + _ struct{} `type:"structure"` + + // The unique name of the created ruleset. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRulesetOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateRulesetOutput) GoString() string { + return s.String() +} + +// SetName sets the Name field's value. +func (s *CreateRulesetOutput) SetName(v string) *CreateRulesetOutput { + s.Name = &v + return s +} + +type CreateScheduleInput struct { + _ struct{} `type:"structure"` + + // The date or dates and time or times when the jobs are to be run. For more + // information, see Cron expressions (https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) + // in the Glue DataBrew Developer Guide. + // + // CronExpression is a required field + CronExpression *string `min:"1" type:"string" required:"true"` + + // The name or names of one or more jobs to be run. + JobNames []*string `type:"list"` // A unique name for the schedule. Valid characters are alphanumeric (A-Z, a-z, // 0-9), hyphen (-), period (.), and space. @@ -5605,9 +6306,7 @@ type DatabaseInputDefinition struct { _ struct{} `type:"structure"` // The table within the target database. - // - // DatabaseTableName is a required field - DatabaseTableName *string `min:"1" type:"string" required:"true"` + DatabaseTableName *string `min:"1" type:"string"` // The Glue Connection that stores the connection information for the target // database. @@ -5615,6 +6314,10 @@ type DatabaseInputDefinition struct { // GlueConnectionName is a required field GlueConnectionName *string `min:"1" type:"string" required:"true"` + // Custom SQL to run against the provided Glue connection. This SQL will be + // used as the input for DataBrew projects and jobs. + QueryString *string `min:"1" type:"string"` + // Represents an Amazon S3 location (bucket name and object key) where DataBrew // can read input data, or write output from a job. TempDirectory *S3Location `type:"structure"` @@ -5641,9 +6344,6 @@ func (s DatabaseInputDefinition) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *DatabaseInputDefinition) Validate() error { invalidParams := request.ErrInvalidParams{Context: "DatabaseInputDefinition"} - if s.DatabaseTableName == nil { - invalidParams.Add(request.NewErrParamRequired("DatabaseTableName")) - } if s.DatabaseTableName != nil && len(*s.DatabaseTableName) < 1 { invalidParams.Add(request.NewErrParamMinLen("DatabaseTableName", 1)) } @@ -5653,6 +6353,9 @@ func (s *DatabaseInputDefinition) Validate() error { if s.GlueConnectionName != nil && len(*s.GlueConnectionName) < 1 { invalidParams.Add(request.NewErrParamMinLen("GlueConnectionName", 1)) } + if s.QueryString != nil && len(*s.QueryString) < 1 { + invalidParams.Add(request.NewErrParamMinLen("QueryString", 1)) + } if s.TempDirectory != nil { if err := s.TempDirectory.Validate(); err != nil { invalidParams.AddNested("TempDirectory", err.(request.ErrInvalidParams)) @@ -5677,6 +6380,12 @@ func (s *DatabaseInputDefinition) SetGlueConnectionName(v string) *DatabaseInput return s } +// SetQueryString sets the QueryString field's value. +func (s *DatabaseInputDefinition) SetQueryString(v string) *DatabaseInputDefinition { + s.QueryString = &v + return s +} + // SetTempDirectory sets the TempDirectory field's value. func (s *DatabaseInputDefinition) SetTempDirectory(v *S3Location) *DatabaseInputDefinition { s.TempDirectory = v @@ -6521,6 +7230,88 @@ func (s *DeleteRecipeVersionOutput) SetRecipeVersion(v string) *DeleteRecipeVers return s } +type DeleteRulesetInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The name of the ruleset to be deleted. + // + // Name is a required field + Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRulesetInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRulesetInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteRulesetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteRulesetInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *DeleteRulesetInput) SetName(v string) *DeleteRulesetInput { + s.Name = &v + return s +} + +type DeleteRulesetOutput struct { + _ struct{} `type:"structure"` + + // The name of the deleted ruleset. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRulesetOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteRulesetOutput) GoString() string { + return s.String() +} + +// SetName sets the Name field's value. +func (s *DeleteRulesetOutput) SetName(v string) *DeleteRulesetOutput { + s.Name = &v + return s +} + type DeleteScheduleInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -6930,6 +7721,9 @@ type DescribeJobOutput struct { // // * RECIPE - The job applies one or more transformations to a dataset. Type *string `type:"string" enum:"JobType"` + + // List of validation configurations that are applied to the profile job. + ValidationConfigurations []*ValidationConfiguration `min:"1" type:"list"` } // String returns the string representation. @@ -7088,6 +7882,12 @@ func (s *DescribeJobOutput) SetType(v string) *DescribeJobOutput { return s } +// SetValidationConfigurations sets the ValidationConfigurations field's value. +func (s *DescribeJobOutput) SetValidationConfigurations(v []*ValidationConfiguration) *DescribeJobOutput { + s.ValidationConfigurations = v + return s +} + type DescribeJobRunInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -7221,6 +8021,9 @@ type DescribeJobRunOutput struct { // The current state of the job run entity itself. State *string `type:"string" enum:"JobRunState"` + + // List of validation configurations that are applied to the profile job. + ValidationConfigurations []*ValidationConfiguration `min:"1" type:"list"` } // String returns the string representation. @@ -7349,6 +8152,12 @@ func (s *DescribeJobRunOutput) SetState(v string) *DescribeJobRunOutput { return s } +// SetValidationConfigurations sets the ValidationConfigurations field's value. +func (s *DescribeJobRunOutput) SetValidationConfigurations(v []*ValidationConfiguration) *DescribeJobRunOutput { + s.ValidationConfigurations = v + return s +} + type DescribeProjectInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -7760,10 +8569,10 @@ func (s *DescribeRecipeOutput) SetTags(v map[string]*string) *DescribeRecipeOutp return s } -type DescribeScheduleInput struct { +type DescribeRulesetInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The name of the schedule to be described. + // The name of the ruleset to be described. // // Name is a required field Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` @@ -7774,7 +8583,7 @@ type DescribeScheduleInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeScheduleInput) String() string { +func (s DescribeRulesetInput) String() string { return awsutil.Prettify(s) } @@ -7783,13 +8592,13 @@ func (s DescribeScheduleInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeScheduleInput) GoString() string { +func (s DescribeRulesetInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeScheduleInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeScheduleInput"} +func (s *DescribeRulesetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeRulesetInput"} if s.Name == nil { invalidParams.Add(request.NewErrParamRequired("Name")) } @@ -7804,44 +8613,47 @@ func (s *DescribeScheduleInput) Validate() error { } // SetName sets the Name field's value. -func (s *DescribeScheduleInput) SetName(v string) *DescribeScheduleInput { +func (s *DescribeRulesetInput) SetName(v string) *DescribeRulesetInput { s.Name = &v return s } -type DescribeScheduleOutput struct { +type DescribeRulesetOutput struct { _ struct{} `type:"structure"` - // The date and time that the schedule was created. + // The date and time that the ruleset was created. CreateDate *time.Time `type:"timestamp"` - // The identifier (user name) of the user who created the schedule. + // The Amazon Resource Name (ARN) of the user who created the ruleset. CreatedBy *string `type:"string"` - // The date or dates and time or times when the jobs are to be run for the schedule. - // For more information, see Cron expressions (https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) - // in the Glue DataBrew Developer Guide. - CronExpression *string `min:"1" type:"string"` - - // The name or names of one or more jobs to be run by using the schedule. - JobNames []*string `type:"list"` + // The description of the ruleset. + Description *string `type:"string"` - // The identifier (user name) of the user who last modified the schedule. + // The Amazon Resource Name (ARN) of the user who last modified the ruleset. LastModifiedBy *string `type:"string"` - // The date and time that the schedule was last modified. + // The modification date and time of the ruleset. LastModifiedDate *time.Time `type:"timestamp"` - // The name of the schedule. + // The name of the ruleset. // // Name is a required field Name *string `min:"1" type:"string" required:"true"` - // The Amazon Resource Name (ARN) of the schedule. + // The Amazon Resource Name (ARN) for the ruleset. ResourceArn *string `min:"20" type:"string"` - // Metadata tags associated with this schedule. + // A list of rules that are defined with the ruleset. A rule includes one or + // more checks to be validated on a DataBrew dataset. + Rules []*Rule `min:"1" type:"list"` + + // Metadata tags that have been applied to the ruleset. Tags map[string]*string `min:"1" type:"map"` + + // The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is + // associated with. + TargetArn *string `min:"20" type:"string"` } // String returns the string representation. @@ -7849,7 +8661,7 @@ type DescribeScheduleOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeScheduleOutput) String() string { +func (s DescribeRulesetOutput) String() string { return awsutil.Prettify(s) } @@ -7858,72 +8670,350 @@ func (s DescribeScheduleOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s DescribeScheduleOutput) GoString() string { +func (s DescribeRulesetOutput) GoString() string { return s.String() } // SetCreateDate sets the CreateDate field's value. -func (s *DescribeScheduleOutput) SetCreateDate(v time.Time) *DescribeScheduleOutput { +func (s *DescribeRulesetOutput) SetCreateDate(v time.Time) *DescribeRulesetOutput { s.CreateDate = &v return s } // SetCreatedBy sets the CreatedBy field's value. -func (s *DescribeScheduleOutput) SetCreatedBy(v string) *DescribeScheduleOutput { +func (s *DescribeRulesetOutput) SetCreatedBy(v string) *DescribeRulesetOutput { s.CreatedBy = &v return s } -// SetCronExpression sets the CronExpression field's value. -func (s *DescribeScheduleOutput) SetCronExpression(v string) *DescribeScheduleOutput { - s.CronExpression = &v - return s -} - -// SetJobNames sets the JobNames field's value. -func (s *DescribeScheduleOutput) SetJobNames(v []*string) *DescribeScheduleOutput { - s.JobNames = v +// SetDescription sets the Description field's value. +func (s *DescribeRulesetOutput) SetDescription(v string) *DescribeRulesetOutput { + s.Description = &v return s } // SetLastModifiedBy sets the LastModifiedBy field's value. -func (s *DescribeScheduleOutput) SetLastModifiedBy(v string) *DescribeScheduleOutput { +func (s *DescribeRulesetOutput) SetLastModifiedBy(v string) *DescribeRulesetOutput { s.LastModifiedBy = &v return s } // SetLastModifiedDate sets the LastModifiedDate field's value. -func (s *DescribeScheduleOutput) SetLastModifiedDate(v time.Time) *DescribeScheduleOutput { +func (s *DescribeRulesetOutput) SetLastModifiedDate(v time.Time) *DescribeRulesetOutput { s.LastModifiedDate = &v return s } // SetName sets the Name field's value. -func (s *DescribeScheduleOutput) SetName(v string) *DescribeScheduleOutput { +func (s *DescribeRulesetOutput) SetName(v string) *DescribeRulesetOutput { s.Name = &v return s } // SetResourceArn sets the ResourceArn field's value. -func (s *DescribeScheduleOutput) SetResourceArn(v string) *DescribeScheduleOutput { +func (s *DescribeRulesetOutput) SetResourceArn(v string) *DescribeRulesetOutput { s.ResourceArn = &v return s } +// SetRules sets the Rules field's value. +func (s *DescribeRulesetOutput) SetRules(v []*Rule) *DescribeRulesetOutput { + s.Rules = v + return s +} + // SetTags sets the Tags field's value. -func (s *DescribeScheduleOutput) SetTags(v map[string]*string) *DescribeScheduleOutput { +func (s *DescribeRulesetOutput) SetTags(v map[string]*string) *DescribeRulesetOutput { s.Tags = v return s } -// Represents a set of options that define how DataBrew will interpret a Microsoft -// Excel file when creating a dataset from that file. -type ExcelOptions struct { - _ struct{} `type:"structure"` +// SetTargetArn sets the TargetArn field's value. +func (s *DescribeRulesetOutput) SetTargetArn(v string) *DescribeRulesetOutput { + s.TargetArn = &v + return s +} - // A variable that specifies whether the first row in the file is parsed as - // the header. If this value is false, column names are auto-generated. - HeaderRow *bool `type:"boolean"` +type DescribeScheduleInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The name of the schedule to be described. + // + // Name is a required field + Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeScheduleInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeScheduleInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeScheduleInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeScheduleInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *DescribeScheduleInput) SetName(v string) *DescribeScheduleInput { + s.Name = &v + return s +} + +type DescribeScheduleOutput struct { + _ struct{} `type:"structure"` + + // The date and time that the schedule was created. + CreateDate *time.Time `type:"timestamp"` + + // The identifier (user name) of the user who created the schedule. + CreatedBy *string `type:"string"` + + // The date or dates and time or times when the jobs are to be run for the schedule. + // For more information, see Cron expressions (https://docs.aws.amazon.com/databrew/latest/dg/jobs.cron.html) + // in the Glue DataBrew Developer Guide. + CronExpression *string `min:"1" type:"string"` + + // The name or names of one or more jobs to be run by using the schedule. + JobNames []*string `type:"list"` + + // The identifier (user name) of the user who last modified the schedule. + LastModifiedBy *string `type:"string"` + + // The date and time that the schedule was last modified. + LastModifiedDate *time.Time `type:"timestamp"` + + // The name of the schedule. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of the schedule. + ResourceArn *string `min:"20" type:"string"` + + // Metadata tags associated with this schedule. + Tags map[string]*string `min:"1" type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeScheduleOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeScheduleOutput) GoString() string { + return s.String() +} + +// SetCreateDate sets the CreateDate field's value. +func (s *DescribeScheduleOutput) SetCreateDate(v time.Time) *DescribeScheduleOutput { + s.CreateDate = &v + return s +} + +// SetCreatedBy sets the CreatedBy field's value. +func (s *DescribeScheduleOutput) SetCreatedBy(v string) *DescribeScheduleOutput { + s.CreatedBy = &v + return s +} + +// SetCronExpression sets the CronExpression field's value. +func (s *DescribeScheduleOutput) SetCronExpression(v string) *DescribeScheduleOutput { + s.CronExpression = &v + return s +} + +// SetJobNames sets the JobNames field's value. +func (s *DescribeScheduleOutput) SetJobNames(v []*string) *DescribeScheduleOutput { + s.JobNames = v + return s +} + +// SetLastModifiedBy sets the LastModifiedBy field's value. +func (s *DescribeScheduleOutput) SetLastModifiedBy(v string) *DescribeScheduleOutput { + s.LastModifiedBy = &v + return s +} + +// SetLastModifiedDate sets the LastModifiedDate field's value. +func (s *DescribeScheduleOutput) SetLastModifiedDate(v time.Time) *DescribeScheduleOutput { + s.LastModifiedDate = &v + return s +} + +// SetName sets the Name field's value. +func (s *DescribeScheduleOutput) SetName(v string) *DescribeScheduleOutput { + s.Name = &v + return s +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *DescribeScheduleOutput) SetResourceArn(v string) *DescribeScheduleOutput { + s.ResourceArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *DescribeScheduleOutput) SetTags(v map[string]*string) *DescribeScheduleOutput { + s.Tags = v + return s +} + +// Configuration of entity detection for a profile job. When undefined, entity +// detection is disabled. +type EntityDetectorConfiguration struct { + _ struct{} `type:"structure"` + + // Configuration of statistics that are allowed to be run on columns that contain + // detected entities. When undefined, no statistics will be computed on columns + // that contain detected entities. + AllowedStatistics []*AllowedStatistics `min:"1" type:"list"` + + // Entity types to detect. Can be any of the following: + // + // * USA_SSN + // + // * EMAIL + // + // * USA_ITIN + // + // * USA_PASSPORT_NUMBER + // + // * PHONE_NUMBER + // + // * USA_DRIVING_LICENSE + // + // * BANK_ACCOUNT + // + // * CREDIT_CARD + // + // * IP_ADDRESS + // + // * MAC_ADDRESS + // + // * USA_DEA_NUMBER + // + // * USA_HCPCS_CODE + // + // * USA_NATIONAL_PROVIDER_IDENTIFIER + // + // * USA_NATIONAL_DRUG_CODE + // + // * USA_HEALTH_INSURANCE_CLAIM_NUMBER + // + // * USA_MEDICARE_BENEFICIARY_IDENTIFIER + // + // * USA_CPT_CODE + // + // * PERSON_NAME + // + // * DATE + // + // The Entity type group USA_ALL is also supported, and includes all of the + // above entity types except PERSON_NAME and DATE. + // + // EntityTypes is a required field + EntityTypes []*string `min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EntityDetectorConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EntityDetectorConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EntityDetectorConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EntityDetectorConfiguration"} + if s.AllowedStatistics != nil && len(s.AllowedStatistics) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AllowedStatistics", 1)) + } + if s.EntityTypes == nil { + invalidParams.Add(request.NewErrParamRequired("EntityTypes")) + } + if s.EntityTypes != nil && len(s.EntityTypes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("EntityTypes", 1)) + } + if s.AllowedStatistics != nil { + for i, v := range s.AllowedStatistics { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "AllowedStatistics", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAllowedStatistics sets the AllowedStatistics field's value. +func (s *EntityDetectorConfiguration) SetAllowedStatistics(v []*AllowedStatistics) *EntityDetectorConfiguration { + s.AllowedStatistics = v + return s +} + +// SetEntityTypes sets the EntityTypes field's value. +func (s *EntityDetectorConfiguration) SetEntityTypes(v []*string) *EntityDetectorConfiguration { + s.EntityTypes = v + return s +} + +// Represents a set of options that define how DataBrew will interpret a Microsoft +// Excel file when creating a dataset from that file. +type ExcelOptions struct { + _ struct{} `type:"structure"` + + // A variable that specifies whether the first row in the file is parsed as + // the header. If this value is false, column names are auto-generated. + HeaderRow *bool `type:"boolean"` // One or more sheet numbers in the Excel file that will be included in the // dataset. @@ -8059,7 +9149,7 @@ func (s *FilesLimit) SetOrderedBy(v string) *FilesLimit { } // Represents a structure for defining parameter conditions. Supported conditions -// are described here: Supported conditions for dynamic datasets (https://docs-aws.amazon.com/databrew/latest/dg/datasets.multiple-files.html#conditions.for.dynamic.datasets) +// are described here: Supported conditions for dynamic datasets (https://docs.aws.amazon.com/databrew/latest/dg/datasets.multiple-files.html#conditions.for.dynamic.datasets) // in the Glue DataBrew Developer Guide. type FilterExpression struct { _ struct{} `type:"structure"` @@ -8210,6 +9300,9 @@ type Input struct { // Connection information for dataset input files stored in a database. DatabaseInputDefinition *DatabaseInputDefinition `type:"structure"` + // Contains additional resource information needed for specific datasets. + Metadata *Metadata `type:"structure"` + // The Amazon S3 location where the data is stored. S3InputDefinition *S3Location `type:"structure"` } @@ -8245,6 +9338,11 @@ func (s *Input) Validate() error { invalidParams.AddNested("DatabaseInputDefinition", err.(request.ErrInvalidParams)) } } + if s.Metadata != nil { + if err := s.Metadata.Validate(); err != nil { + invalidParams.AddNested("Metadata", err.(request.ErrInvalidParams)) + } + } if s.S3InputDefinition != nil { if err := s.S3InputDefinition.Validate(); err != nil { invalidParams.AddNested("S3InputDefinition", err.(request.ErrInvalidParams)) @@ -8269,6 +9367,12 @@ func (s *Input) SetDatabaseInputDefinition(v *DatabaseInputDefinition) *Input { return s } +// SetMetadata sets the Metadata field's value. +func (s *Input) SetMetadata(v *Metadata) *Input { + s.Metadata = v + return s +} + // SetS3InputDefinition sets the S3InputDefinition field's value. func (s *Input) SetS3InputDefinition(v *S3Location) *Input { s.S3InputDefinition = v @@ -8430,6 +9534,9 @@ type Job struct { // // * RECIPE - A job to apply one or more transformations to a dataset. Type *string `type:"string" enum:"JobType"` + + // List of validation configurations that are applied to the profile job. + ValidationConfigurations []*ValidationConfiguration `min:"1" type:"list"` } // String returns the string representation. @@ -8588,6 +9695,12 @@ func (s *Job) SetType(v string) *Job { return s } +// SetValidationConfigurations sets the ValidationConfigurations field's value. +func (s *Job) SetValidationConfigurations(v []*ValidationConfiguration) *Job { + s.ValidationConfigurations = v + return s +} + // Represents one run of a DataBrew job. type JobRun struct { _ struct{} `type:"structure"` @@ -8649,6 +9762,9 @@ type JobRun struct { // The current state of the job run entity itself. State *string `type:"string" enum:"JobRunState"` + + // List of validation configurations that are applied to the profile job run. + ValidationConfigurations []*ValidationConfiguration `min:"1" type:"list"` } // String returns the string representation. @@ -8771,6 +9887,12 @@ func (s *JobRun) SetState(v string) *JobRun { return s } +// SetValidationConfigurations sets the ValidationConfigurations field's value. +func (s *JobRun) SetValidationConfigurations(v []*ValidationConfiguration) *JobRun { + s.ValidationConfigurations = v + return s +} + // A sample configuration for profile jobs only, which determines the number // of rows on which the profile job is run. If a JobSample value isn't provided, // the default is used. The default value is CUSTOM_ROWS for the mode parameter @@ -9530,17 +10652,21 @@ func (s *ListRecipesOutput) SetRecipes(v []*Recipe) *ListRecipesOutput { return s } -type ListSchedulesInput struct { +type ListRulesetsInput struct { _ struct{} `type:"structure" nopayload:"true"` - // The name of the job that these schedules apply to. - JobName *string `location:"querystring" locationName:"jobName" min:"1" type:"string"` - // The maximum number of results to return in this request. MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` - // The token returned by a previous call to retrieve the next set of results. + // A token generated by DataBrew that specifies where to continue pagination + // if a previous request was truncated. To get the next set of pages, pass in + // the NextToken value from the response object of the previous page call. NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of a resource (dataset). Using this parameter + // indicates to return only those rulesets that are associated with the specified + // resource. + TargetArn *string `location:"querystring" locationName:"targetArn" min:"20" type:"string"` } // String returns the string representation. @@ -9548,7 +10674,7 @@ type ListSchedulesInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListSchedulesInput) String() string { +func (s ListRulesetsInput) String() string { return awsutil.Prettify(s) } @@ -9557,13 +10683,124 @@ func (s ListSchedulesInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ListSchedulesInput) GoString() string { +func (s ListRulesetsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListSchedulesInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListSchedulesInput"} +func (s *ListRulesetsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListRulesetsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.TargetArn != nil && len(*s.TargetArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("TargetArn", 20)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListRulesetsInput) SetMaxResults(v int64) *ListRulesetsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListRulesetsInput) SetNextToken(v string) *ListRulesetsInput { + s.NextToken = &v + return s +} + +// SetTargetArn sets the TargetArn field's value. +func (s *ListRulesetsInput) SetTargetArn(v string) *ListRulesetsInput { + s.TargetArn = &v + return s +} + +type ListRulesetsOutput struct { + _ struct{} `type:"structure"` + + // A token that you can use in a subsequent call to retrieve the next set of + // results. + NextToken *string `min:"1" type:"string"` + + // A list of RulesetItem. RulesetItem contains meta data of a ruleset. + // + // Rulesets is a required field + Rulesets []*RulesetItem `type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRulesetsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListRulesetsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListRulesetsOutput) SetNextToken(v string) *ListRulesetsOutput { + s.NextToken = &v + return s +} + +// SetRulesets sets the Rulesets field's value. +func (s *ListRulesetsOutput) SetRulesets(v []*RulesetItem) *ListRulesetsOutput { + s.Rulesets = v + return s +} + +type ListSchedulesInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The name of the job that these schedules apply to. + JobName *string `location:"querystring" locationName:"jobName" min:"1" type:"string"` + + // The maximum number of results to return in this request. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The token returned by a previous call to retrieve the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSchedulesInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSchedulesInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListSchedulesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListSchedulesInput"} if s.JobName != nil && len(*s.JobName) < 1 { invalidParams.Add(request.NewErrParamMinLen("JobName", 1)) } @@ -9722,6 +10959,52 @@ func (s *ListTagsForResourceOutput) SetTags(v map[string]*string) *ListTagsForRe return s } +// Contains additional resource information needed for specific datasets. +type Metadata struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) associated with the dataset. Currently, DataBrew + // only supports ARNs from Amazon AppFlow. + SourceArn *string `min:"20" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Metadata) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Metadata) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Metadata) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Metadata"} + if s.SourceArn != nil && len(*s.SourceArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("SourceArn", 20)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetSourceArn sets the SourceArn field's value. +func (s *Metadata) SetSourceArn(v string) *Metadata { + s.SourceArn = &v + return s +} + // Represents options that specify how and where in Amazon S3 DataBrew writes // the output generated by recipe jobs or profile jobs. type Output struct { @@ -9980,6 +11263,10 @@ type ProfileConfiguration struct { // is undefined, the profile job will run all supported inter-column evaluations. DatasetStatisticsConfiguration *StatisticsConfiguration `type:"structure"` + // Configuration of entity detection for a profile job. When undefined, entity + // detection is disabled. + EntityDetectorConfiguration *EntityDetectorConfiguration `type:"structure"` + // List of column selectors. ProfileColumns can be used to select columns from // the dataset. When ProfileColumns is undefined, the profile job will profile // all supported columns. @@ -10028,6 +11315,11 @@ func (s *ProfileConfiguration) Validate() error { invalidParams.AddNested("DatasetStatisticsConfiguration", err.(request.ErrInvalidParams)) } } + if s.EntityDetectorConfiguration != nil { + if err := s.EntityDetectorConfiguration.Validate(); err != nil { + invalidParams.AddNested("EntityDetectorConfiguration", err.(request.ErrInvalidParams)) + } + } if s.ProfileColumns != nil { for i, v := range s.ProfileColumns { if v == nil { @@ -10057,6 +11349,12 @@ func (s *ProfileConfiguration) SetDatasetStatisticsConfiguration(v *StatisticsCo return s } +// SetEntityDetectorConfiguration sets the EntityDetectorConfiguration field's value. +func (s *ProfileConfiguration) SetEntityDetectorConfiguration(v *EntityDetectorConfiguration) *ProfileConfiguration { + s.EntityDetectorConfiguration = v + return s +} + // SetProfileColumns sets the ProfileColumns field's value. func (s *ProfileConfiguration) SetProfileColumns(v []*ColumnSelector) *ProfileConfiguration { s.ProfileColumns = v @@ -10754,23 +12052,290 @@ func (s *ResourceNotFoundException) Message() string { return "" } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *ResourceNotFoundException) OrigErr() error { - return nil +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ResourceNotFoundException) OrigErr() error { + return nil +} + +func (s *ResourceNotFoundException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ResourceNotFoundException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ResourceNotFoundException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Represents a single data quality requirement that should be validated in +// the scope of this dataset. +type Rule struct { + _ struct{} `type:"structure"` + + // The expression which includes column references, condition names followed + // by variable references, possibly grouped and combined with other conditions. + // For example, (:col1 starts_with :prefix1 or :col1 starts_with :prefix2) and + // (:col1 ends_with :suffix1 or :col1 ends_with :suffix2). Column and value + // references are substitution variables that should start with the ':' symbol. + // Depending on the context, substitution variables' values can be either an + // actual value or a column name. These values are defined in the SubstitutionMap. + // If a CheckExpression starts with a column reference, then ColumnSelectors + // in the rule should be null. If ColumnSelectors has been defined, then there + // should be no columnn reference in the left side of a condition, for example, + // is_between :val1 and :val2. + // + // CheckExpression is a required field + CheckExpression *string `min:"4" type:"string" required:"true"` + + // List of column selectors. Selectors can be used to select columns using a + // name or regular expression from the dataset. Rule will be applied to selected + // columns. + ColumnSelectors []*ColumnSelector `min:"1" type:"list"` + + // A value that specifies whether the rule is disabled. Once a rule is disabled, + // a profile job will not validate it during a job run. Default value is false. + Disabled *bool `type:"boolean"` + + // The name of the rule. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // The map of substitution variable names to their values used in a check expression. + // Variable names should start with a ':' (colon). Variable values can either + // be actual values or column names. To differentiate between the two, column + // names should be enclosed in backticks, for example, ":col1": "`Column A`". + SubstitutionMap map[string]*string `type:"map"` + + // The threshold used with a non-aggregate check expression. Non-aggregate check + // expressions will be applied to each row in a specific column, and the threshold + // will be used to determine whether the validation succeeds. + Threshold *Threshold `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Rule) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Rule) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Rule) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Rule"} + if s.CheckExpression == nil { + invalidParams.Add(request.NewErrParamRequired("CheckExpression")) + } + if s.CheckExpression != nil && len(*s.CheckExpression) < 4 { + invalidParams.Add(request.NewErrParamMinLen("CheckExpression", 4)) + } + if s.ColumnSelectors != nil && len(s.ColumnSelectors) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ColumnSelectors", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.ColumnSelectors != nil { + for i, v := range s.ColumnSelectors { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ColumnSelectors", i), err.(request.ErrInvalidParams)) + } + } + } + if s.Threshold != nil { + if err := s.Threshold.Validate(); err != nil { + invalidParams.AddNested("Threshold", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCheckExpression sets the CheckExpression field's value. +func (s *Rule) SetCheckExpression(v string) *Rule { + s.CheckExpression = &v + return s +} + +// SetColumnSelectors sets the ColumnSelectors field's value. +func (s *Rule) SetColumnSelectors(v []*ColumnSelector) *Rule { + s.ColumnSelectors = v + return s +} + +// SetDisabled sets the Disabled field's value. +func (s *Rule) SetDisabled(v bool) *Rule { + s.Disabled = &v + return s +} + +// SetName sets the Name field's value. +func (s *Rule) SetName(v string) *Rule { + s.Name = &v + return s +} + +// SetSubstitutionMap sets the SubstitutionMap field's value. +func (s *Rule) SetSubstitutionMap(v map[string]*string) *Rule { + s.SubstitutionMap = v + return s +} + +// SetThreshold sets the Threshold field's value. +func (s *Rule) SetThreshold(v *Threshold) *Rule { + s.Threshold = v + return s +} + +// Contains metadata about the ruleset. +type RulesetItem struct { + _ struct{} `type:"structure"` + + // The ID of the Amazon Web Services account that owns the ruleset. + AccountId *string `type:"string"` + + // The date and time that the ruleset was created. + CreateDate *time.Time `type:"timestamp"` + + // The Amazon Resource Name (ARN) of the user who created the ruleset. + CreatedBy *string `type:"string"` + + // The description of the ruleset. + Description *string `type:"string"` + + // The Amazon Resource Name (ARN) of the user who last modified the ruleset. + LastModifiedBy *string `type:"string"` + + // The modification date and time of the ruleset. + LastModifiedDate *time.Time `type:"timestamp"` + + // The name of the ruleset. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) for the ruleset. + ResourceArn *string `min:"20" type:"string"` + + // The number of rules that are defined in the ruleset. + RuleCount *int64 `type:"integer"` + + // Metadata tags that have been applied to the ruleset. + Tags map[string]*string `min:"1" type:"map"` + + // The Amazon Resource Name (ARN) of a resource (dataset) that the ruleset is + // associated with. + // + // TargetArn is a required field + TargetArn *string `min:"20" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RulesetItem) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RulesetItem) GoString() string { + return s.String() +} + +// SetAccountId sets the AccountId field's value. +func (s *RulesetItem) SetAccountId(v string) *RulesetItem { + s.AccountId = &v + return s +} + +// SetCreateDate sets the CreateDate field's value. +func (s *RulesetItem) SetCreateDate(v time.Time) *RulesetItem { + s.CreateDate = &v + return s +} + +// SetCreatedBy sets the CreatedBy field's value. +func (s *RulesetItem) SetCreatedBy(v string) *RulesetItem { + s.CreatedBy = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *RulesetItem) SetDescription(v string) *RulesetItem { + s.Description = &v + return s +} + +// SetLastModifiedBy sets the LastModifiedBy field's value. +func (s *RulesetItem) SetLastModifiedBy(v string) *RulesetItem { + s.LastModifiedBy = &v + return s +} + +// SetLastModifiedDate sets the LastModifiedDate field's value. +func (s *RulesetItem) SetLastModifiedDate(v time.Time) *RulesetItem { + s.LastModifiedDate = &v + return s +} + +// SetName sets the Name field's value. +func (s *RulesetItem) SetName(v string) *RulesetItem { + s.Name = &v + return s +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *RulesetItem) SetResourceArn(v string) *RulesetItem { + s.ResourceArn = &v + return s } -func (s *ResourceNotFoundException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// SetRuleCount sets the RuleCount field's value. +func (s *RulesetItem) SetRuleCount(v int64) *RulesetItem { + s.RuleCount = &v + return s } -// Status code returns the HTTP status code for the request's response error. -func (s *ResourceNotFoundException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetTags sets the Tags field's value. +func (s *RulesetItem) SetTags(v map[string]*string) *RulesetItem { + s.Tags = v + return s } -// RequestID returns the service's response RequestID for request. -func (s *ResourceNotFoundException) RequestID() string { - return s.RespMetadata.RequestID +// SetTargetArn sets the TargetArn field's value. +func (s *RulesetItem) SetTargetArn(v string) *RulesetItem { + s.TargetArn = &v + return s } // Represents an Amazon S3 location (bucket name and object key) where DataBrew @@ -11072,7 +12637,11 @@ type SendProjectSessionActionInput struct { // A unique identifier for an interactive session that's currently open and // ready for work. The action will be performed on this session. - ClientSessionId *string `min:"1" type:"string"` + // + // ClientSessionId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by SendProjectSessionActionInput's + // String and GoString methods. + ClientSessionId *string `min:"1" type:"string" sensitive:"true"` // The name of the project to apply the action to. // @@ -11437,7 +13006,11 @@ type StartProjectSessionOutput struct { _ struct{} `type:"structure"` // A system-generated identifier for the session. - ClientSessionId *string `min:"1" type:"string"` + // + // ClientSessionId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by StartProjectSessionOutput's + // String and GoString methods. + ClientSessionId *string `min:"1" type:"string" sensitive:"true"` // The name of the project to be acted upon. // @@ -11797,6 +13370,75 @@ func (s TagResourceOutput) GoString() string { return s.String() } +// The threshold used with a non-aggregate check expression. The non-aggregate +// check expression will be applied to each row in a specific column. Then the +// threshold will be used to determine whether the validation succeeds. +type Threshold struct { + _ struct{} `type:"structure"` + + // The type of a threshold. Used for comparison of an actual count of rows that + // satisfy the rule to the threshold value. + Type *string `type:"string" enum:"ThresholdType"` + + // Unit of threshold value. Can be either a COUNT or PERCENTAGE of the full + // sample size used for validation. + Unit *string `type:"string" enum:"ThresholdUnit"` + + // The value of a threshold. + // + // Value is a required field + Value *float64 `type:"double" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Threshold) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Threshold) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Threshold) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Threshold"} + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetType sets the Type field's value. +func (s *Threshold) SetType(v string) *Threshold { + s.Type = &v + return s +} + +// SetUnit sets the Unit field's value. +func (s *Threshold) SetUnit(v string) *Threshold { + s.Unit = &v + return s +} + +// SetValue sets the Value field's value. +func (s *Threshold) SetValue(v float64) *Threshold { + s.Value = &v + return s +} + type UntagResourceInput struct { _ struct{} `type:"structure" nopayload:"true"` @@ -12083,6 +13725,9 @@ type UpdateProfileJobInput struct { // The job's timeout in minutes. A job that attempts to run longer than this // timeout period ends with a status of TIMEOUT. Timeout *int64 `type:"integer"` + + // List of validation configurations that are applied to the profile job. + ValidationConfigurations []*ValidationConfiguration `min:"1" type:"list"` } // String returns the string representation. @@ -12124,6 +13769,9 @@ func (s *UpdateProfileJobInput) Validate() error { if s.RoleArn != nil && len(*s.RoleArn) < 20 { invalidParams.Add(request.NewErrParamMinLen("RoleArn", 20)) } + if s.ValidationConfigurations != nil && len(s.ValidationConfigurations) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ValidationConfigurations", 1)) + } if s.Configuration != nil { if err := s.Configuration.Validate(); err != nil { invalidParams.AddNested("Configuration", err.(request.ErrInvalidParams)) @@ -12134,6 +13782,16 @@ func (s *UpdateProfileJobInput) Validate() error { invalidParams.AddNested("OutputLocation", err.(request.ErrInvalidParams)) } } + if s.ValidationConfigurations != nil { + for i, v := range s.ValidationConfigurations { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ValidationConfigurations", i), err.(request.ErrInvalidParams)) + } + } + } if invalidParams.Len() > 0 { return invalidParams @@ -12207,6 +13865,12 @@ func (s *UpdateProfileJobInput) SetTimeout(v int64) *UpdateProfileJobInput { return s } +// SetValidationConfigurations sets the ValidationConfigurations field's value. +func (s *UpdateProfileJobInput) SetValidationConfigurations(v []*ValidationConfiguration) *UpdateProfileJobInput { + s.ValidationConfigurations = v + return s +} + type UpdateProfileJobOutput struct { _ struct{} `type:"structure"` @@ -12707,6 +14371,125 @@ func (s *UpdateRecipeOutput) SetName(v string) *UpdateRecipeOutput { return s } +type UpdateRulesetInput struct { + _ struct{} `type:"structure"` + + // The description of the ruleset. + Description *string `type:"string"` + + // The name of the ruleset to be updated. + // + // Name is a required field + Name *string `location:"uri" locationName:"name" min:"1" type:"string" required:"true"` + + // A list of rules that are defined with the ruleset. A rule includes one or + // more checks to be validated on a DataBrew dataset. + // + // Rules is a required field + Rules []*Rule `min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateRulesetInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateRulesetInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateRulesetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateRulesetInput"} + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.Rules == nil { + invalidParams.Add(request.NewErrParamRequired("Rules")) + } + if s.Rules != nil && len(s.Rules) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Rules", 1)) + } + if s.Rules != nil { + for i, v := range s.Rules { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Rules", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDescription sets the Description field's value. +func (s *UpdateRulesetInput) SetDescription(v string) *UpdateRulesetInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *UpdateRulesetInput) SetName(v string) *UpdateRulesetInput { + s.Name = &v + return s +} + +// SetRules sets the Rules field's value. +func (s *UpdateRulesetInput) SetRules(v []*Rule) *UpdateRulesetInput { + s.Rules = v + return s +} + +type UpdateRulesetOutput struct { + _ struct{} `type:"structure"` + + // The name of the updated ruleset. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateRulesetOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateRulesetOutput) GoString() string { + return s.String() +} + +// SetName sets the Name field's value. +func (s *UpdateRulesetOutput) SetName(v string) *UpdateRulesetOutput { + s.Name = &v + return s +} + type UpdateScheduleInput struct { _ struct{} `type:"structure"` @@ -12817,6 +14600,70 @@ func (s *UpdateScheduleOutput) SetName(v string) *UpdateScheduleOutput { return s } +// Configuration for data quality validation. Used to select the Rulesets and +// Validation Mode to be used in the profile job. When ValidationConfiguration +// is null, the profile job will run without data quality validation. +type ValidationConfiguration struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for the ruleset to be validated in the profile + // job. The TargetArn of the selected ruleset should be the same as the Amazon + // Resource Name (ARN) of the dataset that is associated with the profile job. + // + // RulesetArn is a required field + RulesetArn *string `min:"20" type:"string" required:"true"` + + // Mode of data quality validation. Default mode is “CHECK_ALL” which verifies + // all rules defined in the selected ruleset. + ValidationMode *string `type:"string" enum:"ValidationMode"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ValidationConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ValidationConfiguration"} + if s.RulesetArn == nil { + invalidParams.Add(request.NewErrParamRequired("RulesetArn")) + } + if s.RulesetArn != nil && len(*s.RulesetArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("RulesetArn", 20)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetRulesetArn sets the RulesetArn field's value. +func (s *ValidationConfiguration) SetRulesetArn(v string) *ValidationConfiguration { + s.RulesetArn = &v + return s +} + +// SetValidationMode sets the ValidationMode field's value. +func (s *ValidationConfiguration) SetValidationMode(v string) *ValidationConfiguration { + s.ValidationMode = &v + return s +} + // The input parameters for this request failed validation. type ValidationException struct { _ struct{} `type:"structure"` @@ -12885,6 +14732,9 @@ func (s *ValidationException) RequestID() string { type ViewFrame struct { _ struct{} `type:"structure"` + // Controls if analytics computation is enabled or disabled. Enabled by default. + Analytics *string `type:"string" enum:"AnalyticsMode"` + // The number of columns to include in the view frame, beginning with the StartColumnIndex // value and ignoring any columns in the HiddenColumns list. ColumnRange *int64 `type:"integer"` @@ -12892,10 +14742,17 @@ type ViewFrame struct { // A list of columns to hide in the view frame. HiddenColumns []*string `type:"list"` + // The number of rows to include in the view frame, beginning with the StartRowIndex + // value. + RowRange *int64 `type:"integer"` + // The starting index for the range of columns to return in the view frame. // // StartColumnIndex is a required field StartColumnIndex *int64 `type:"integer" required:"true"` + + // The starting index for the range of rows to return in the view frame. + StartRowIndex *int64 `type:"integer"` } // String returns the string representation. @@ -12929,6 +14786,12 @@ func (s *ViewFrame) Validate() error { return nil } +// SetAnalytics sets the Analytics field's value. +func (s *ViewFrame) SetAnalytics(v string) *ViewFrame { + s.Analytics = &v + return s +} + // SetColumnRange sets the ColumnRange field's value. func (s *ViewFrame) SetColumnRange(v int64) *ViewFrame { s.ColumnRange = &v @@ -12941,12 +14804,40 @@ func (s *ViewFrame) SetHiddenColumns(v []*string) *ViewFrame { return s } +// SetRowRange sets the RowRange field's value. +func (s *ViewFrame) SetRowRange(v int64) *ViewFrame { + s.RowRange = &v + return s +} + // SetStartColumnIndex sets the StartColumnIndex field's value. func (s *ViewFrame) SetStartColumnIndex(v int64) *ViewFrame { s.StartColumnIndex = &v return s } +// SetStartRowIndex sets the StartRowIndex field's value. +func (s *ViewFrame) SetStartRowIndex(v int64) *ViewFrame { + s.StartRowIndex = &v + return s +} + +const ( + // AnalyticsModeEnable is a AnalyticsMode enum value + AnalyticsModeEnable = "ENABLE" + + // AnalyticsModeDisable is a AnalyticsMode enum value + AnalyticsModeDisable = "DISABLE" +) + +// AnalyticsMode_Values returns all elements of the AnalyticsMode enum +func AnalyticsMode_Values() []string { + return []string{ + AnalyticsModeEnable, + AnalyticsModeDisable, + } +} + const ( // CompressionFormatGzip is a CompressionFormat enum value CompressionFormatGzip = "GZIP" @@ -13302,3 +15193,55 @@ func Source_Values() []string { SourceDatabase, } } + +const ( + // ThresholdTypeGreaterThanOrEqual is a ThresholdType enum value + ThresholdTypeGreaterThanOrEqual = "GREATER_THAN_OR_EQUAL" + + // ThresholdTypeLessThanOrEqual is a ThresholdType enum value + ThresholdTypeLessThanOrEqual = "LESS_THAN_OR_EQUAL" + + // ThresholdTypeGreaterThan is a ThresholdType enum value + ThresholdTypeGreaterThan = "GREATER_THAN" + + // ThresholdTypeLessThan is a ThresholdType enum value + ThresholdTypeLessThan = "LESS_THAN" +) + +// ThresholdType_Values returns all elements of the ThresholdType enum +func ThresholdType_Values() []string { + return []string{ + ThresholdTypeGreaterThanOrEqual, + ThresholdTypeLessThanOrEqual, + ThresholdTypeGreaterThan, + ThresholdTypeLessThan, + } +} + +const ( + // ThresholdUnitCount is a ThresholdUnit enum value + ThresholdUnitCount = "COUNT" + + // ThresholdUnitPercentage is a ThresholdUnit enum value + ThresholdUnitPercentage = "PERCENTAGE" +) + +// ThresholdUnit_Values returns all elements of the ThresholdUnit enum +func ThresholdUnit_Values() []string { + return []string{ + ThresholdUnitCount, + ThresholdUnitPercentage, + } +} + +const ( + // ValidationModeCheckAll is a ValidationMode enum value + ValidationModeCheckAll = "CHECK_ALL" +) + +// ValidationMode_Values returns all elements of the ValidationMode enum +func ValidationMode_Values() []string { + return []string{ + ValidationModeCheckAll, + } +} diff --git a/service/gluedatabrew/gluedatabrewiface/interface.go b/service/gluedatabrew/gluedatabrewiface/interface.go index 13add3ee7c..29e5be404e 100644 --- a/service/gluedatabrew/gluedatabrewiface/interface.go +++ b/service/gluedatabrew/gluedatabrewiface/interface.go @@ -84,6 +84,10 @@ type GlueDataBrewAPI interface { CreateRecipeJobWithContext(aws.Context, *gluedatabrew.CreateRecipeJobInput, ...request.Option) (*gluedatabrew.CreateRecipeJobOutput, error) CreateRecipeJobRequest(*gluedatabrew.CreateRecipeJobInput) (*request.Request, *gluedatabrew.CreateRecipeJobOutput) + CreateRuleset(*gluedatabrew.CreateRulesetInput) (*gluedatabrew.CreateRulesetOutput, error) + CreateRulesetWithContext(aws.Context, *gluedatabrew.CreateRulesetInput, ...request.Option) (*gluedatabrew.CreateRulesetOutput, error) + CreateRulesetRequest(*gluedatabrew.CreateRulesetInput) (*request.Request, *gluedatabrew.CreateRulesetOutput) + CreateSchedule(*gluedatabrew.CreateScheduleInput) (*gluedatabrew.CreateScheduleOutput, error) CreateScheduleWithContext(aws.Context, *gluedatabrew.CreateScheduleInput, ...request.Option) (*gluedatabrew.CreateScheduleOutput, error) CreateScheduleRequest(*gluedatabrew.CreateScheduleInput) (*request.Request, *gluedatabrew.CreateScheduleOutput) @@ -104,6 +108,10 @@ type GlueDataBrewAPI interface { DeleteRecipeVersionWithContext(aws.Context, *gluedatabrew.DeleteRecipeVersionInput, ...request.Option) (*gluedatabrew.DeleteRecipeVersionOutput, error) DeleteRecipeVersionRequest(*gluedatabrew.DeleteRecipeVersionInput) (*request.Request, *gluedatabrew.DeleteRecipeVersionOutput) + DeleteRuleset(*gluedatabrew.DeleteRulesetInput) (*gluedatabrew.DeleteRulesetOutput, error) + DeleteRulesetWithContext(aws.Context, *gluedatabrew.DeleteRulesetInput, ...request.Option) (*gluedatabrew.DeleteRulesetOutput, error) + DeleteRulesetRequest(*gluedatabrew.DeleteRulesetInput) (*request.Request, *gluedatabrew.DeleteRulesetOutput) + DeleteSchedule(*gluedatabrew.DeleteScheduleInput) (*gluedatabrew.DeleteScheduleOutput, error) DeleteScheduleWithContext(aws.Context, *gluedatabrew.DeleteScheduleInput, ...request.Option) (*gluedatabrew.DeleteScheduleOutput, error) DeleteScheduleRequest(*gluedatabrew.DeleteScheduleInput) (*request.Request, *gluedatabrew.DeleteScheduleOutput) @@ -128,6 +136,10 @@ type GlueDataBrewAPI interface { DescribeRecipeWithContext(aws.Context, *gluedatabrew.DescribeRecipeInput, ...request.Option) (*gluedatabrew.DescribeRecipeOutput, error) DescribeRecipeRequest(*gluedatabrew.DescribeRecipeInput) (*request.Request, *gluedatabrew.DescribeRecipeOutput) + DescribeRuleset(*gluedatabrew.DescribeRulesetInput) (*gluedatabrew.DescribeRulesetOutput, error) + DescribeRulesetWithContext(aws.Context, *gluedatabrew.DescribeRulesetInput, ...request.Option) (*gluedatabrew.DescribeRulesetOutput, error) + DescribeRulesetRequest(*gluedatabrew.DescribeRulesetInput) (*request.Request, *gluedatabrew.DescribeRulesetOutput) + DescribeSchedule(*gluedatabrew.DescribeScheduleInput) (*gluedatabrew.DescribeScheduleOutput, error) DescribeScheduleWithContext(aws.Context, *gluedatabrew.DescribeScheduleInput, ...request.Option) (*gluedatabrew.DescribeScheduleOutput, error) DescribeScheduleRequest(*gluedatabrew.DescribeScheduleInput) (*request.Request, *gluedatabrew.DescribeScheduleOutput) @@ -174,6 +186,13 @@ type GlueDataBrewAPI interface { ListRecipesPages(*gluedatabrew.ListRecipesInput, func(*gluedatabrew.ListRecipesOutput, bool) bool) error ListRecipesPagesWithContext(aws.Context, *gluedatabrew.ListRecipesInput, func(*gluedatabrew.ListRecipesOutput, bool) bool, ...request.Option) error + ListRulesets(*gluedatabrew.ListRulesetsInput) (*gluedatabrew.ListRulesetsOutput, error) + ListRulesetsWithContext(aws.Context, *gluedatabrew.ListRulesetsInput, ...request.Option) (*gluedatabrew.ListRulesetsOutput, error) + ListRulesetsRequest(*gluedatabrew.ListRulesetsInput) (*request.Request, *gluedatabrew.ListRulesetsOutput) + + ListRulesetsPages(*gluedatabrew.ListRulesetsInput, func(*gluedatabrew.ListRulesetsOutput, bool) bool) error + ListRulesetsPagesWithContext(aws.Context, *gluedatabrew.ListRulesetsInput, func(*gluedatabrew.ListRulesetsOutput, bool) bool, ...request.Option) error + ListSchedules(*gluedatabrew.ListSchedulesInput) (*gluedatabrew.ListSchedulesOutput, error) ListSchedulesWithContext(aws.Context, *gluedatabrew.ListSchedulesInput, ...request.Option) (*gluedatabrew.ListSchedulesOutput, error) ListSchedulesRequest(*gluedatabrew.ListSchedulesInput) (*request.Request, *gluedatabrew.ListSchedulesOutput) @@ -233,6 +252,10 @@ type GlueDataBrewAPI interface { UpdateRecipeJobWithContext(aws.Context, *gluedatabrew.UpdateRecipeJobInput, ...request.Option) (*gluedatabrew.UpdateRecipeJobOutput, error) UpdateRecipeJobRequest(*gluedatabrew.UpdateRecipeJobInput) (*request.Request, *gluedatabrew.UpdateRecipeJobOutput) + UpdateRuleset(*gluedatabrew.UpdateRulesetInput) (*gluedatabrew.UpdateRulesetOutput, error) + UpdateRulesetWithContext(aws.Context, *gluedatabrew.UpdateRulesetInput, ...request.Option) (*gluedatabrew.UpdateRulesetOutput, error) + UpdateRulesetRequest(*gluedatabrew.UpdateRulesetInput) (*request.Request, *gluedatabrew.UpdateRulesetOutput) + UpdateSchedule(*gluedatabrew.UpdateScheduleInput) (*gluedatabrew.UpdateScheduleOutput, error) UpdateScheduleWithContext(aws.Context, *gluedatabrew.UpdateScheduleInput, ...request.Option) (*gluedatabrew.UpdateScheduleOutput, error) UpdateScheduleRequest(*gluedatabrew.UpdateScheduleInput) (*request.Request, *gluedatabrew.UpdateScheduleOutput) diff --git a/service/ivs/api.go b/service/ivs/api.go index 1bfb1da45d..f5f321bb8e 100644 --- a/service/ivs/api.go +++ b/service/ivs/api.go @@ -1216,6 +1216,88 @@ func (c *IVS) GetStreamKeyWithContext(ctx aws.Context, input *GetStreamKeyInput, return out, req.Send() } +const opGetStreamSession = "GetStreamSession" + +// GetStreamSessionRequest generates a "aws/request.Request" representing the +// client's request for the GetStreamSession operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetStreamSession for more information on using the GetStreamSession +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetStreamSessionRequest method. +// req, resp := client.GetStreamSessionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamSession +func (c *IVS) GetStreamSessionRequest(input *GetStreamSessionInput) (req *request.Request, output *GetStreamSessionOutput) { + op := &request.Operation{ + Name: opGetStreamSession, + HTTPMethod: "POST", + HTTPPath: "/GetStreamSession", + } + + if input == nil { + input = &GetStreamSessionInput{} + } + + output = &GetStreamSessionOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetStreamSession API operation for Amazon Interactive Video Service. +// +// Gets metadata on a specified stream. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Interactive Video Service's +// API operation GetStreamSession for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// +// * AccessDeniedException +// +// * ValidationException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/GetStreamSession +func (c *IVS) GetStreamSession(input *GetStreamSessionInput) (*GetStreamSessionOutput, error) { + req, out := c.GetStreamSessionRequest(input) + return out, req.Send() +} + +// GetStreamSessionWithContext is the same as GetStreamSession with the addition of +// the ability to pass a context and additional request options. +// +// See GetStreamSession for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IVS) GetStreamSessionWithContext(ctx aws.Context, input *GetStreamSessionInput, opts ...request.Option) (*GetStreamSessionOutput, error) { + req, out := c.GetStreamSessionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opImportPlaybackKeyPair = "ImportPlaybackKeyPair" // ImportPlaybackKeyPairRequest generates a "aws/request.Request" representing the @@ -1871,6 +1953,147 @@ func (c *IVS) ListStreamKeysPagesWithContext(ctx aws.Context, input *ListStreamK return p.Err() } +const opListStreamSessions = "ListStreamSessions" + +// ListStreamSessionsRequest generates a "aws/request.Request" representing the +// client's request for the ListStreamSessions operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListStreamSessions for more information on using the ListStreamSessions +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListStreamSessionsRequest method. +// req, resp := client.ListStreamSessionsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessions +func (c *IVS) ListStreamSessionsRequest(input *ListStreamSessionsInput) (req *request.Request, output *ListStreamSessionsOutput) { + op := &request.Operation{ + Name: opListStreamSessions, + HTTPMethod: "POST", + HTTPPath: "/ListStreamSessions", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "maxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListStreamSessionsInput{} + } + + output = &ListStreamSessionsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListStreamSessions API operation for Amazon Interactive Video Service. +// +// Gets a summary of current and previous streams for a specified channel in +// your account, in the AWS region where the API request is processed. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Interactive Video Service's +// API operation ListStreamSessions for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// +// * AccessDeniedException +// +// * ValidationException +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14/ListStreamSessions +func (c *IVS) ListStreamSessions(input *ListStreamSessionsInput) (*ListStreamSessionsOutput, error) { + req, out := c.ListStreamSessionsRequest(input) + return out, req.Send() +} + +// ListStreamSessionsWithContext is the same as ListStreamSessions with the addition of +// the ability to pass a context and additional request options. +// +// See ListStreamSessions for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IVS) ListStreamSessionsWithContext(ctx aws.Context, input *ListStreamSessionsInput, opts ...request.Option) (*ListStreamSessionsOutput, error) { + req, out := c.ListStreamSessionsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListStreamSessionsPages iterates over the pages of a ListStreamSessions operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListStreamSessions method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListStreamSessions operation. +// pageNum := 0 +// err := client.ListStreamSessionsPages(params, +// func(page *ivs.ListStreamSessionsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *IVS) ListStreamSessionsPages(input *ListStreamSessionsInput, fn func(*ListStreamSessionsOutput, bool) bool) error { + return c.ListStreamSessionsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListStreamSessionsPagesWithContext same as ListStreamSessionsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *IVS) ListStreamSessionsPagesWithContext(ctx aws.Context, input *ListStreamSessionsInput, fn func(*ListStreamSessionsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListStreamSessionsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListStreamSessionsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListStreamSessionsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + const opListStreams = "ListStreams" // ListStreamsRequest generates a "aws/request.Request" representing the @@ -2595,6 +2818,66 @@ func (s *AccessDeniedException) RequestID() string { return s.RespMetadata.RequestID } +// Object specifying a stream’s audio configuration. +type AudioConfiguration struct { + _ struct{} `type:"structure"` + + // Number of audio channels. + Channels *int64 `locationName:"channels" type:"long"` + + // Codec used for the audio encoding. + Codec *string `locationName:"codec" type:"string"` + + // Number of audio samples recorded per second. + SampleRate *int64 `locationName:"sampleRate" type:"long"` + + // The expected ingest bitrate (bits per second). This is configured in the + // encoder. + TargetBitrate *int64 `locationName:"targetBitrate" type:"long"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AudioConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AudioConfiguration) GoString() string { + return s.String() +} + +// SetChannels sets the Channels field's value. +func (s *AudioConfiguration) SetChannels(v int64) *AudioConfiguration { + s.Channels = &v + return s +} + +// SetCodec sets the Codec field's value. +func (s *AudioConfiguration) SetCodec(v string) *AudioConfiguration { + s.Codec = &v + return s +} + +// SetSampleRate sets the SampleRate field's value. +func (s *AudioConfiguration) SetSampleRate(v int64) *AudioConfiguration { + s.SampleRate = &v + return s +} + +// SetTargetBitrate sets the TargetBitrate field's value. +func (s *AudioConfiguration) SetTargetBitrate(v int64) *AudioConfiguration { + s.TargetBitrate = &v + return s +} + // Error related to a specific channel, specified by its ARN. type BatchError struct { _ struct{} `type:"structure"` @@ -4205,19 +4488,18 @@ func (s *GetStreamOutput) SetStream(v *Stream) *GetStreamOutput { return s } -type ImportPlaybackKeyPairInput struct { +type GetStreamSessionInput struct { _ struct{} `type:"structure"` - // Playback-key-pair name. The value does not need to be unique. - Name *string `locationName:"name" type:"string"` - - // The public portion of a customer-generated key pair. + // ARN of the channel resource // - // PublicKeyMaterial is a required field - PublicKeyMaterial *string `locationName:"publicKeyMaterial" type:"string" required:"true"` + // ChannelArn is a required field + ChannelArn *string `locationName:"channelArn" min:"1" type:"string" required:"true"` - // Any tags provided with the request are added to the playback key pair tags. - Tags map[string]*string `locationName:"tags" type:"map"` + // Unique identifier for a live or previously live stream in the specified channel. + // If no streamId is provided, this returns the most recent stream session for + // the channel, if it exists. + StreamId *string `locationName:"streamId" min:"26" type:"string"` } // String returns the string representation. @@ -4225,7 +4507,7 @@ type ImportPlaybackKeyPairInput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ImportPlaybackKeyPairInput) String() string { +func (s GetStreamSessionInput) String() string { return awsutil.Prettify(s) } @@ -4234,15 +4516,21 @@ func (s ImportPlaybackKeyPairInput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ImportPlaybackKeyPairInput) GoString() string { +func (s GetStreamSessionInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ImportPlaybackKeyPairInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ImportPlaybackKeyPairInput"} - if s.PublicKeyMaterial == nil { - invalidParams.Add(request.NewErrParamRequired("PublicKeyMaterial")) +func (s *GetStreamSessionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetStreamSessionInput"} + if s.ChannelArn == nil { + invalidParams.Add(request.NewErrParamRequired("ChannelArn")) + } + if s.ChannelArn != nil && len(*s.ChannelArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 1)) + } + if s.StreamId != nil && len(*s.StreamId) < 26 { + invalidParams.Add(request.NewErrParamMinLen("StreamId", 26)) } if invalidParams.Len() > 0 { @@ -4251,29 +4539,23 @@ func (s *ImportPlaybackKeyPairInput) Validate() error { return nil } -// SetName sets the Name field's value. -func (s *ImportPlaybackKeyPairInput) SetName(v string) *ImportPlaybackKeyPairInput { - s.Name = &v - return s -} - -// SetPublicKeyMaterial sets the PublicKeyMaterial field's value. -func (s *ImportPlaybackKeyPairInput) SetPublicKeyMaterial(v string) *ImportPlaybackKeyPairInput { - s.PublicKeyMaterial = &v +// SetChannelArn sets the ChannelArn field's value. +func (s *GetStreamSessionInput) SetChannelArn(v string) *GetStreamSessionInput { + s.ChannelArn = &v return s } -// SetTags sets the Tags field's value. -func (s *ImportPlaybackKeyPairInput) SetTags(v map[string]*string) *ImportPlaybackKeyPairInput { - s.Tags = v +// SetStreamId sets the StreamId field's value. +func (s *GetStreamSessionInput) SetStreamId(v string) *GetStreamSessionInput { + s.StreamId = &v return s } -type ImportPlaybackKeyPairOutput struct { +type GetStreamSessionOutput struct { _ struct{} `type:"structure"` - // A key pair used to sign and validate a playback authorization token. - KeyPair *PlaybackKeyPair `locationName:"keyPair" type:"structure"` + // List of stream details. + StreamSession *StreamSession `locationName:"streamSession" type:"structure"` } // String returns the string representation. @@ -4281,7 +4563,7 @@ type ImportPlaybackKeyPairOutput struct { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ImportPlaybackKeyPairOutput) String() string { +func (s GetStreamSessionOutput) String() string { return awsutil.Prettify(s) } @@ -4290,22 +4572,159 @@ func (s ImportPlaybackKeyPairOutput) String() string { // API parameter values that are decorated as "sensitive" in the API will not // be included in the string output. The member name will be present, but the // value will be replaced with "sensitive". -func (s ImportPlaybackKeyPairOutput) GoString() string { +func (s GetStreamSessionOutput) GoString() string { return s.String() } -// SetKeyPair sets the KeyPair field's value. -func (s *ImportPlaybackKeyPairOutput) SetKeyPair(v *PlaybackKeyPair) *ImportPlaybackKeyPairOutput { - s.KeyPair = v +// SetStreamSession sets the StreamSession field's value. +func (s *GetStreamSessionOutput) SetStreamSession(v *StreamSession) *GetStreamSessionOutput { + s.StreamSession = v return s } -type InternalServerException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +type ImportPlaybackKeyPairInput struct { + _ struct{} `type:"structure"` - // Unexpected error during processing of request. - ExceptionMessage *string `locationName:"exceptionMessage" type:"string"` + // Playback-key-pair name. The value does not need to be unique. + Name *string `locationName:"name" type:"string"` + + // The public portion of a customer-generated key pair. + // + // PublicKeyMaterial is a required field + PublicKeyMaterial *string `locationName:"publicKeyMaterial" type:"string" required:"true"` + + // Any tags provided with the request are added to the playback key pair tags. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ImportPlaybackKeyPairInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ImportPlaybackKeyPairInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ImportPlaybackKeyPairInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ImportPlaybackKeyPairInput"} + if s.PublicKeyMaterial == nil { + invalidParams.Add(request.NewErrParamRequired("PublicKeyMaterial")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *ImportPlaybackKeyPairInput) SetName(v string) *ImportPlaybackKeyPairInput { + s.Name = &v + return s +} + +// SetPublicKeyMaterial sets the PublicKeyMaterial field's value. +func (s *ImportPlaybackKeyPairInput) SetPublicKeyMaterial(v string) *ImportPlaybackKeyPairInput { + s.PublicKeyMaterial = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *ImportPlaybackKeyPairInput) SetTags(v map[string]*string) *ImportPlaybackKeyPairInput { + s.Tags = v + return s +} + +type ImportPlaybackKeyPairOutput struct { + _ struct{} `type:"structure"` + + // A key pair used to sign and validate a playback authorization token. + KeyPair *PlaybackKeyPair `locationName:"keyPair" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ImportPlaybackKeyPairOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ImportPlaybackKeyPairOutput) GoString() string { + return s.String() +} + +// SetKeyPair sets the KeyPair field's value. +func (s *ImportPlaybackKeyPairOutput) SetKeyPair(v *PlaybackKeyPair) *ImportPlaybackKeyPairOutput { + s.KeyPair = v + return s +} + +// Object specifying the ingest configuration set up by the broadcaster, usually +// in an encoder. +type IngestConfiguration struct { + _ struct{} `type:"structure"` + + // Encoder settings for audio. + Audio *AudioConfiguration `locationName:"audio" type:"structure"` + + // Encoder settings for video. + Video *VideoConfiguration `locationName:"video" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s IngestConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s IngestConfiguration) GoString() string { + return s.String() +} + +// SetAudio sets the Audio field's value. +func (s *IngestConfiguration) SetAudio(v *AudioConfiguration) *IngestConfiguration { + s.Audio = v + return s +} + +// SetVideo sets the Video field's value. +func (s *IngestConfiguration) SetVideo(v *VideoConfiguration) *IngestConfiguration { + s.Video = v + return s +} + +type InternalServerException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + // Unexpected error during processing of request. + ExceptionMessage *string `locationName:"exceptionMessage" type:"string"` Message_ *string `locationName:"message" type:"string"` } @@ -4789,9 +5208,124 @@ func (s *ListStreamKeysOutput) SetStreamKeys(v []*StreamKeySummary) *ListStreamK return s } +type ListStreamSessionsInput struct { + _ struct{} `type:"structure"` + + // Channel ARN used to filter the list. + // + // ChannelArn is a required field + ChannelArn *string `locationName:"channelArn" min:"1" type:"string" required:"true"` + + // Maximum number of streams to return. Default: 50. + MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` + + // The first stream to retrieve. This is used for pagination; see the nextToken + // response field. + NextToken *string `locationName:"nextToken" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListStreamSessionsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListStreamSessionsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListStreamSessionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListStreamSessionsInput"} + if s.ChannelArn == nil { + invalidParams.Add(request.NewErrParamRequired("ChannelArn")) + } + if s.ChannelArn != nil && len(*s.ChannelArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ChannelArn", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetChannelArn sets the ChannelArn field's value. +func (s *ListStreamSessionsInput) SetChannelArn(v string) *ListStreamSessionsInput { + s.ChannelArn = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListStreamSessionsInput) SetMaxResults(v int64) *ListStreamSessionsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListStreamSessionsInput) SetNextToken(v string) *ListStreamSessionsInput { + s.NextToken = &v + return s +} + +type ListStreamSessionsOutput struct { + _ struct{} `type:"structure"` + + // If there are more streams than maxResults, use nextToken in the request to + // get the next set. + NextToken *string `locationName:"nextToken" type:"string"` + + // StreamSessions is a required field + StreamSessions []*StreamSessionSummary `locationName:"streamSessions" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListStreamSessionsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListStreamSessionsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListStreamSessionsOutput) SetNextToken(v string) *ListStreamSessionsOutput { + s.NextToken = &v + return s +} + +// SetStreamSessions sets the StreamSessions field's value. +func (s *ListStreamSessionsOutput) SetStreamSessions(v []*StreamSessionSummary) *ListStreamSessionsOutput { + s.StreamSessions = v + return s +} + type ListStreamsInput struct { _ struct{} `type:"structure"` + // Filters the stream list to match the specified criterion. + FilterBy *StreamFilters `locationName:"filterBy" type:"structure"` + // Maximum number of streams to return. Default: 50. MaxResults *int64 `locationName:"maxResults" min:"1" type:"integer"` @@ -4831,6 +5365,12 @@ func (s *ListStreamsInput) Validate() error { return nil } +// SetFilterBy sets the FilterBy field's value. +func (s *ListStreamsInput) SetFilterBy(v *StreamFilters) *ListStreamsInput { + s.FilterBy = v + return s +} + // SetMaxResults sets the MaxResults field's value. func (s *ListStreamsInput) SetMaxResults(v int64) *ListStreamsInput { s.MaxResults = &v @@ -5661,6 +6201,9 @@ type Stream struct { // The stream’s state. State *string `locationName:"state" type:"string" enum:"StreamState"` + // Unique identifier for a live or previously live stream in the specified channel. + StreamId *string `locationName:"streamId" min:"26" type:"string"` + // A count of concurrent views of the stream. Typically, a new view appears // in viewerCount within 15 seconds of when video playback starts and a view // is removed from viewerCount within 1 minute of when video playback ends. @@ -5716,12 +6259,101 @@ func (s *Stream) SetState(v string) *Stream { return s } +// SetStreamId sets the StreamId field's value. +func (s *Stream) SetStreamId(v string) *Stream { + s.StreamId = &v + return s +} + // SetViewerCount sets the ViewerCount field's value. func (s *Stream) SetViewerCount(v int64) *Stream { s.ViewerCount = &v return s } +// Object specifying a stream’s events. For a list of events, see Using Amazon +// EventBridge with Amazon IVS (https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html). +type StreamEvent struct { + _ struct{} `type:"structure"` + + // UTC ISO-8601 formatted timestamp of when the event occurred. + EventTime *time.Time `locationName:"eventTime" type:"timestamp" timestampFormat:"iso8601"` + + // Name that identifies the stream event within a type. + Name *string `locationName:"name" type:"string"` + + // Logical group for certain events. + Type *string `locationName:"type" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamEvent) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamEvent) GoString() string { + return s.String() +} + +// SetEventTime sets the EventTime field's value. +func (s *StreamEvent) SetEventTime(v time.Time) *StreamEvent { + s.EventTime = &v + return s +} + +// SetName sets the Name field's value. +func (s *StreamEvent) SetName(v string) *StreamEvent { + s.Name = &v + return s +} + +// SetType sets the Type field's value. +func (s *StreamEvent) SetType(v string) *StreamEvent { + s.Type = &v + return s +} + +// Object specifying the stream attribute on which to filter. +type StreamFilters struct { + _ struct{} `type:"structure"` + + // The stream’s health. + Health *string `locationName:"health" type:"string" enum:"StreamHealth"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamFilters) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamFilters) GoString() string { + return s.String() +} + +// SetHealth sets the Health field's value. +func (s *StreamFilters) SetHealth(v string) *StreamFilters { + s.Health = &v + return s +} + // Object specifying a stream key. type StreamKey struct { _ struct{} `type:"structure"` @@ -5835,6 +6467,157 @@ func (s *StreamKeySummary) SetTags(v map[string]*string) *StreamKeySummary { return s } +// Object that captures the Amazon IVS configuration that the customer provisioned, +// the ingest configurations that the broadcaster used, and the most recent +// Amazon IVS stream events it encountered. +type StreamSession struct { + _ struct{} `type:"structure"` + + // The properties of the channel at the time of going live. + Channel *Channel `locationName:"channel" type:"structure"` + + // UTC ISO-8601 formatted timestamp of when the channel went offline. For live + // streams, this is NULL. + EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"` + + // The properties of the incoming RTMP stream for the stream. + IngestConfiguration *IngestConfiguration `locationName:"ingestConfiguration" type:"structure"` + + // The properties of recording the live stream. + RecordingConfiguration *RecordingConfiguration `locationName:"recordingConfiguration" type:"structure"` + + // UTC ISO-8601 formatted timestamp of when the channel went live. + StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"` + + // Unique identifier for a live or previously live stream in the specified channel. + StreamId *string `locationName:"streamId" min:"26" type:"string"` + + // List of Amazon IVS events that the stream encountered. The list is sorted + // by most recent events and contains up to 500 events. For Amazon IVS events, + // see Using Amazon EventBridge with Amazon IVS (https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html). + TruncatedEvents []*StreamEvent `locationName:"truncatedEvents" type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamSession) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamSession) GoString() string { + return s.String() +} + +// SetChannel sets the Channel field's value. +func (s *StreamSession) SetChannel(v *Channel) *StreamSession { + s.Channel = v + return s +} + +// SetEndTime sets the EndTime field's value. +func (s *StreamSession) SetEndTime(v time.Time) *StreamSession { + s.EndTime = &v + return s +} + +// SetIngestConfiguration sets the IngestConfiguration field's value. +func (s *StreamSession) SetIngestConfiguration(v *IngestConfiguration) *StreamSession { + s.IngestConfiguration = v + return s +} + +// SetRecordingConfiguration sets the RecordingConfiguration field's value. +func (s *StreamSession) SetRecordingConfiguration(v *RecordingConfiguration) *StreamSession { + s.RecordingConfiguration = v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *StreamSession) SetStartTime(v time.Time) *StreamSession { + s.StartTime = &v + return s +} + +// SetStreamId sets the StreamId field's value. +func (s *StreamSession) SetStreamId(v string) *StreamSession { + s.StreamId = &v + return s +} + +// SetTruncatedEvents sets the TruncatedEvents field's value. +func (s *StreamSession) SetTruncatedEvents(v []*StreamEvent) *StreamSession { + s.TruncatedEvents = v + return s +} + +// Summary information about a stream session. +type StreamSessionSummary struct { + _ struct{} `type:"structure"` + + // UTC ISO-8601 formatted timestamp of when the channel went offline. For live + // streams, this is NULL. + EndTime *time.Time `locationName:"endTime" type:"timestamp" timestampFormat:"iso8601"` + + // If true, this stream encountered a quota breach or failure. + HasErrorEvent *bool `locationName:"hasErrorEvent" type:"boolean"` + + // UTC ISO-8601 formatted timestamp of when the channel went live. + StartTime *time.Time `locationName:"startTime" type:"timestamp" timestampFormat:"iso8601"` + + // Unique identifier for a live or previously live stream in the specified channel. + StreamId *string `locationName:"streamId" min:"26" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamSessionSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StreamSessionSummary) GoString() string { + return s.String() +} + +// SetEndTime sets the EndTime field's value. +func (s *StreamSessionSummary) SetEndTime(v time.Time) *StreamSessionSummary { + s.EndTime = &v + return s +} + +// SetHasErrorEvent sets the HasErrorEvent field's value. +func (s *StreamSessionSummary) SetHasErrorEvent(v bool) *StreamSessionSummary { + s.HasErrorEvent = &v + return s +} + +// SetStartTime sets the StartTime field's value. +func (s *StreamSessionSummary) SetStartTime(v time.Time) *StreamSessionSummary { + s.StartTime = &v + return s +} + +// SetStreamId sets the StreamId field's value. +func (s *StreamSessionSummary) SetStreamId(v string) *StreamSessionSummary { + s.StreamId = &v + return s +} + // Summary information about a stream. type StreamSummary struct { _ struct{} `type:"structure"` @@ -5852,6 +6635,9 @@ type StreamSummary struct { // The stream’s state. State *string `locationName:"state" type:"string" enum:"StreamState"` + // Unique identifier for a live or previously live stream in the specified channel. + StreamId *string `locationName:"streamId" min:"26" type:"string"` + // A count of concurrent views of the stream. Typically, a new view appears // in viewerCount within 15 seconds of when video playback starts and a view // is removed from viewerCount within 1 minute of when video playback ends. @@ -5901,6 +6687,12 @@ func (s *StreamSummary) SetState(v string) *StreamSummary { return s } +// SetStreamId sets the StreamId field's value. +func (s *StreamSummary) SetStreamId(v string) *StreamSummary { + s.StreamId = &v + return s +} + // SetViewerCount sets the ViewerCount field's value. func (s *StreamSummary) SetViewerCount(v int64) *StreamSummary { s.ViewerCount = &v @@ -6418,6 +7210,104 @@ func (s *ValidationException) RequestID() string { return s.RespMetadata.RequestID } +// Object specifying a stream’s video configuration. +type VideoConfiguration struct { + _ struct{} `type:"structure"` + + // Indicates the degree of required decoder performance for a profile. Normally + // this is set automatically by the encoder. For details, see the H.264 specification. + AvcLevel *string `locationName:"avcLevel" type:"string"` + + // Indicates to the decoder the requirements for decoding the stream. For definitions + // of the valid values, see the H.264 specification. + AvcProfile *string `locationName:"avcProfile" type:"string"` + + // Codec used for the video encoding. + Codec *string `locationName:"codec" type:"string"` + + // Software or hardware used to encode the video. + Encoder *string `locationName:"encoder" type:"string"` + + // The expected ingest bitrate (bits per second). This is configured in the + // encoder. + TargetBitrate *int64 `locationName:"targetBitrate" type:"long"` + + // The expected ingest framerate. This is configured in the encoder. + TargetFramerate *int64 `locationName:"targetFramerate" type:"long"` + + // Video-resolution height in pixels. + VideoHeight *int64 `locationName:"videoHeight" type:"long"` + + // Video-resolution width in pixels. + VideoWidth *int64 `locationName:"videoWidth" type:"long"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VideoConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s VideoConfiguration) GoString() string { + return s.String() +} + +// SetAvcLevel sets the AvcLevel field's value. +func (s *VideoConfiguration) SetAvcLevel(v string) *VideoConfiguration { + s.AvcLevel = &v + return s +} + +// SetAvcProfile sets the AvcProfile field's value. +func (s *VideoConfiguration) SetAvcProfile(v string) *VideoConfiguration { + s.AvcProfile = &v + return s +} + +// SetCodec sets the Codec field's value. +func (s *VideoConfiguration) SetCodec(v string) *VideoConfiguration { + s.Codec = &v + return s +} + +// SetEncoder sets the Encoder field's value. +func (s *VideoConfiguration) SetEncoder(v string) *VideoConfiguration { + s.Encoder = &v + return s +} + +// SetTargetBitrate sets the TargetBitrate field's value. +func (s *VideoConfiguration) SetTargetBitrate(v int64) *VideoConfiguration { + s.TargetBitrate = &v + return s +} + +// SetTargetFramerate sets the TargetFramerate field's value. +func (s *VideoConfiguration) SetTargetFramerate(v int64) *VideoConfiguration { + s.TargetFramerate = &v + return s +} + +// SetVideoHeight sets the VideoHeight field's value. +func (s *VideoConfiguration) SetVideoHeight(v int64) *VideoConfiguration { + s.VideoHeight = &v + return s +} + +// SetVideoWidth sets the VideoWidth field's value. +func (s *VideoConfiguration) SetVideoWidth(v int64) *VideoConfiguration { + s.VideoWidth = &v + return s +} + const ( // ChannelLatencyModeNormal is a ChannelLatencyMode enum value ChannelLatencyModeNormal = "NORMAL" diff --git a/service/ivs/doc.go b/service/ivs/doc.go index 14a61a1367..719bb1aca3 100644 --- a/service/ivs/doc.go +++ b/service/ivs/doc.go @@ -18,126 +18,199 @@ // For a summary of notable documentation changes in each release, see Document // History (https://docs.aws.amazon.com/ivs/latest/userguide/doc-history.html). // -//

Allowed Header Values

  • Accept: -// application/json

  • Accept-Encoding: -// gzip, deflate

  • Content-Type: application/json

    -//

Resources

The following resources contain -// information about your IVS live stream (see -// Getting Started with Amazon IVS):

  • Channel — Stores -// configuration data related to your live stream. You first create a channel -// and then use the channel’s stream key to start your live stream. See -// the Channel endpoints for more information.

  • Stream -// key — An identifier assigned by Amazon IVS when you create a channel, -// which is then used to authorize streaming. See the StreamKey endpoints -// for more information. Treat the stream key like a secret, since -// it allows anyone to stream to the channel.

  • Playback -// key pair — Video playback may be restricted using playback-authorization +// Allowed Header Values +// +// * Accept: application/json +// +// * Accept-Encoding: gzip, deflate +// +// * Content-Type: application/json +// +// Resources +// +// The following resources contain information about your IVS live stream (see +// Getting Started with Amazon IVS (https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html)): +// +// * Channel — Stores configuration data related to your live stream. You +// first create a channel and then use the channel’s stream key to start +// your live stream. See the Channel endpoints for more information. +// +// * Stream key — An identifier assigned by Amazon IVS when you create +// a channel, which is then used to authorize streaming. See the StreamKey +// endpoints for more information. Treat the stream key like a secret, since +// it allows anyone to stream to the channel. +// +// * Playback key pair — Video playback may be restricted using playback-authorization // tokens, which use public-key encryption. A playback key pair is the public-private // pair of keys used to sign and validate the playback-authorization token. -// See the PlaybackKeyPair endpoints for more information.

  • -//

    Recording configuration — Stores configuration related to recording +// See the PlaybackKeyPair endpoints for more information. +// +// * Recording configuration — Stores configuration related to recording // a live stream and where to store the recorded content. Multiple channels // can reference the same recording configuration. See the Recording Configuration -// endpoints for more information.

Tagging

-//

A tag is a metadata label that you assign to an Amazon Web Services -// resource. A tag comprises a key and a value, both set by -// you. For example, you might set a tag as topic:nature to -// label a particular video category. See Tagging -// Amazon Web Services Resources for more information, including restrictions -// that apply to tags.

Tags can help you identify and organize your -// Amazon Web Services resources. For example, you can use the same tag for -// different resources to indicate that they are related. You can also use -// tags to manage access (see -// Access Tags).

The Amazon IVS API has these tag-related endpoints: -// TagResource, UntagResource, and ListTagsForResource. -// The following resources support tagging: Channels, Stream Keys, Playback -// Key Pairs, and Recording Configurations.

At most 50 tags can be -// applied to a resource.

Authentication versus Authorization -//

Note the differences between these concepts:

  • -// Authentication is about verifying identity. You need to be authenticated -// to sign Amazon IVS API requests.

  • Authorization -// is about granting permissions. You need to be authorized to view Amazon -// IVS private channels. (Private channels are channels that are enabled -// for "playback authorization.")

Authentication -//

All Amazon IVS API requests must be authenticated with a signature. -// The Amazon Web Services Command-Line Interface (CLI) and Amazon IVS Player -// SDKs take care of signing the underlying API calls for you. However, if -// your application calls the Amazon IVS API directly, it’s your responsibility -// to sign the requests.

You generate a signature using valid Amazon -// Web Services credentials that have permission to perform the requested -// action. For example, you must sign PutMetadata requests with a signature -// generated from an IAM user account that has the ivs:PutMetadata -// permission.

For more information:

Channel Endpoints

  • -//

    CreateChannel — Creates a new channel and an associated stream -// key to start streaming.

  • GetChannel — Gets -// the channel configuration for the specified channel ARN (Amazon Resource -// Name).

  • BatchGetChannel — Performs GetChannel -// on multiple ARNs simultaneously.

  • ListChannels -// — Gets summary information about all channels in your account, in the -// Amazon Web Services region where the API request is processed. This list -// can be filtered to match a specified name or recording-configuration ARN. -// Filters are mutually exclusive and cannot be used together. If you try -// to use both filters, you will get an error (409 Conflict Exception).

    -//

  • UpdateChannel — Updates a channel's configuration. -// This does not affect an ongoing stream of this channel. You must stop -// and restart the stream for the changes to take effect.

  • -//

    DeleteChannel — Deletes the specified channel.

    • -//

StreamKey Endpoints

  • CreateStreamKey -// — Creates a stream key, used to initiate a stream, for the specified -// channel ARN.

  • GetStreamKey — Gets stream key -// information for the specified ARN.

  • BatchGetStreamKey -// — Performs GetStreamKey on multiple ARNs simultaneously.

    -//

  • ListStreamKeys — Gets summary information about -// stream keys for the specified channel.

  • DeleteStreamKey -// — Deletes the stream key for the specified ARN, so it can no longer -// be used to stream.

Stream Endpoints

    -//

  • GetStream — Gets information about the active (live) -// stream on a specified channel.

  • ListStreams — -// Gets summary information about live streams in your account, in the Amazon -// Web Services region where the API request is processed.

  • -//

    StopStream — Disconnects the incoming RTMPS stream for the -// specified channel. Can be used in conjunction with DeleteStreamKey -// to prevent further streaming to a channel.

  • PutMetadata -// — Inserts metadata into the active stream of the specified channel. -// At most 5 requests per second per channel are allowed, each with a maximum -// 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend -// batching your data into a single PutMetadata call.) At most 155 requests -// per second per account are allowed.

PlaybackKeyPair -// Endpoints

For more information, see Setting -// Up Private Channels in the Amazon IVS User Guide.

    -//

  • ImportPlaybackKeyPair — Imports the public portion of -// a new key pair and returns its arn and fingerprint. -// The privateKey can then be used to generate viewer authorization -// tokens, to grant viewers access to private channels (channels enabled -// for playback authorization).

  • GetPlaybackKeyPair -// — Gets a specified playback authorization key pair and returns the arn -// and fingerprint. The privateKey held by the -// caller can be used to generate viewer authorization tokens, to grant viewers -// access to private channels.

  • ListPlaybackKeyPairs -// — Gets summary information about playback key pairs.

  • -//

    DeletePlaybackKeyPair — Deletes a specified authorization -// key pair. This invalidates future viewer tokens generated using the key -// pair’s privateKey.

RecordingConfiguration -// Endpoints

Amazon Web -// Services Tags Endpoints

  • TagResource — -// Adds or updates tags for the Amazon Web Services resource with the specified -// ARN.

  • UntagResource — Removes tags from the -// resource with the specified ARN.

  • ListTagsForResource -// — Gets information about Amazon Web Services tags for the specified -// ARN.

+// endpoints for more information. +// +// Tagging +// +// A tag is a metadata label that you assign to an Amazon Web Services resource. +// A tag comprises a key and a value, both set by you. For example, you might +// set a tag as topic:nature to label a particular video category. See Tagging +// Amazon Web Services Resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) +// for more information, including restrictions that apply to tags. +// +// Tags can help you identify and organize your Amazon Web Services resources. +// For example, you can use the same tag for different resources to indicate +// that they are related. You can also use tags to manage access (see Access +// Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html)). +// +// The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, +// and ListTagsForResource. The following resources support tagging: Channels, +// Stream Keys, Playback Key Pairs, and Recording Configurations. +// +// At most 50 tags can be applied to a resource. +// +// Authentication versus Authorization +// +// Note the differences between these concepts: +// +// * Authentication is about verifying identity. You need to be authenticated +// to sign Amazon IVS API requests. +// +// * Authorization is about granting permissions. You need to be authorized +// to view Amazon IVS private channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html). +// (Private channels are channels that are enabled for "playback authorization.") +// +// Authentication +// +// All Amazon IVS API requests must be authenticated with a signature. The Amazon +// Web Services Command-Line Interface (CLI) and Amazon IVS Player SDKs take +// care of signing the underlying API calls for you. However, if your application +// calls the Amazon IVS API directly, it’s your responsibility to sign the +// requests. +// +// You generate a signature using valid Amazon Web Services credentials that +// have permission to perform the requested action. For example, you must sign +// PutMetadata requests with a signature generated from an IAM user account +// that has the ivs:PutMetadata permission. +// +// For more information: +// +// * Authentication and generating signatures — See Authenticating Requests +// (Amazon Web Services Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) +// in the Amazon Web Services General Reference. +// +// * Managing Amazon IVS permissions — See Identity and Access Management +// (https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html) on +// the Security page of the Amazon IVS User Guide. +// +// Channel Endpoints +// +// * CreateChannel — Creates a new channel and an associated stream key +// to start streaming. +// +// * GetChannel — Gets the channel configuration for the specified channel +// ARN (Amazon Resource Name). +// +// * BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously. +// +// * ListChannels — Gets summary information about all channels in your +// account, in the Amazon Web Services region where the API request is processed. +// This list can be filtered to match a specified name or recording-configuration +// ARN. Filters are mutually exclusive and cannot be used together. If you +// try to use both filters, you will get an error (409 Conflict Exception). +// +// * UpdateChannel — Updates a channel's configuration. This does not affect +// an ongoing stream of this channel. You must stop and restart the stream +// for the changes to take effect. +// +// * DeleteChannel — Deletes the specified channel. +// +// StreamKey Endpoints +// +// * CreateStreamKey — Creates a stream key, used to initiate a stream, +// for the specified channel ARN. +// +// * GetStreamKey — Gets stream key information for the specified ARN. +// +// * BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously. +// +// * ListStreamKeys — Gets summary information about stream keys for the +// specified channel. +// +// * DeleteStreamKey — Deletes the stream key for the specified ARN, so +// it can no longer be used to stream. +// +// Stream Endpoints +// +// * GetStream — Gets information about the active (live) stream on a specified +// channel. +// +// * GetStreamSession — Gets metadata on a specified stream. +// +// * ListStreams — Gets summary information about live streams in your +// account, in the Amazon Web Services region where the API request is processed. +// +// * ListStreamSessions — Gets a summary of current and previous streams +// for a specified channel in your account, in the AWS region where the API +// request is processed. +// +// * StopStream — Disconnects the incoming RTMPS stream for the specified +// channel. Can be used in conjunction with DeleteStreamKey to prevent further +// streaming to a channel. +// +// * PutMetadata — Inserts metadata into the active stream of the specified +// channel. At most 5 requests per second per channel are allowed, each with +// a maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we +// recommend batching your data into a single PutMetadata call.) At most +// 155 requests per second per account are allowed. +// +// PlaybackKeyPair Endpoints +// +// For more information, see Setting Up Private Channels (https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html) +// in the Amazon IVS User Guide. +// +// * ImportPlaybackKeyPair — Imports the public portion of a new key pair +// and returns its arn and fingerprint. The privateKey can then be used to +// generate viewer authorization tokens, to grant viewers access to private +// channels (channels enabled for playback authorization). +// +// * GetPlaybackKeyPair — Gets a specified playback authorization key pair +// and returns the arn and fingerprint. The privateKey held by the caller +// can be used to generate viewer authorization tokens, to grant viewers +// access to private channels. +// +// * ListPlaybackKeyPairs — Gets summary information about playback key +// pairs. +// +// * DeletePlaybackKeyPair — Deletes a specified authorization key pair. +// This invalidates future viewer tokens generated using the key pair’s +// privateKey. +// +// RecordingConfiguration Endpoints +// +// * CreateRecordingConfiguration — Creates a new recording configuration, +// used to enable recording to Amazon S3. +// +// * GetRecordingConfiguration — Gets the recording-configuration metadata +// for the specified ARN. +// +// * ListRecordingConfigurations — Gets summary information about all recording +// configurations in your account, in the Amazon Web Services region where +// the API request is processed. +// +// * DeleteRecordingConfiguration — Deletes the recording configuration +// for the specified ARN. +// +// Amazon Web Services Tags Endpoints +// +// * TagResource — Adds or updates tags for the Amazon Web Services resource +// with the specified ARN. +// +// * UntagResource — Removes tags from the resource with the specified +// ARN. +// +// * ListTagsForResource — Gets information about Amazon Web Services tags +// for the specified ARN. // // See https://docs.aws.amazon.com/goto/WebAPI/ivs-2020-07-14 for more information on this service. // diff --git a/service/ivs/ivsiface/interface.go b/service/ivs/ivsiface/interface.go index 65d3cd4618..b7be06f6b3 100644 --- a/service/ivs/ivsiface/interface.go +++ b/service/ivs/ivsiface/interface.go @@ -116,6 +116,10 @@ type IVSAPI interface { GetStreamKeyWithContext(aws.Context, *ivs.GetStreamKeyInput, ...request.Option) (*ivs.GetStreamKeyOutput, error) GetStreamKeyRequest(*ivs.GetStreamKeyInput) (*request.Request, *ivs.GetStreamKeyOutput) + GetStreamSession(*ivs.GetStreamSessionInput) (*ivs.GetStreamSessionOutput, error) + GetStreamSessionWithContext(aws.Context, *ivs.GetStreamSessionInput, ...request.Option) (*ivs.GetStreamSessionOutput, error) + GetStreamSessionRequest(*ivs.GetStreamSessionInput) (*request.Request, *ivs.GetStreamSessionOutput) + ImportPlaybackKeyPair(*ivs.ImportPlaybackKeyPairInput) (*ivs.ImportPlaybackKeyPairOutput, error) ImportPlaybackKeyPairWithContext(aws.Context, *ivs.ImportPlaybackKeyPairInput, ...request.Option) (*ivs.ImportPlaybackKeyPairOutput, error) ImportPlaybackKeyPairRequest(*ivs.ImportPlaybackKeyPairInput) (*request.Request, *ivs.ImportPlaybackKeyPairOutput) @@ -148,6 +152,13 @@ type IVSAPI interface { ListStreamKeysPages(*ivs.ListStreamKeysInput, func(*ivs.ListStreamKeysOutput, bool) bool) error ListStreamKeysPagesWithContext(aws.Context, *ivs.ListStreamKeysInput, func(*ivs.ListStreamKeysOutput, bool) bool, ...request.Option) error + ListStreamSessions(*ivs.ListStreamSessionsInput) (*ivs.ListStreamSessionsOutput, error) + ListStreamSessionsWithContext(aws.Context, *ivs.ListStreamSessionsInput, ...request.Option) (*ivs.ListStreamSessionsOutput, error) + ListStreamSessionsRequest(*ivs.ListStreamSessionsInput) (*request.Request, *ivs.ListStreamSessionsOutput) + + ListStreamSessionsPages(*ivs.ListStreamSessionsInput, func(*ivs.ListStreamSessionsOutput, bool) bool) error + ListStreamSessionsPagesWithContext(aws.Context, *ivs.ListStreamSessionsInput, func(*ivs.ListStreamSessionsOutput, bool) bool, ...request.Option) error + ListStreams(*ivs.ListStreamsInput) (*ivs.ListStreamsOutput, error) ListStreamsWithContext(aws.Context, *ivs.ListStreamsInput, ...request.Option) (*ivs.ListStreamsOutput, error) ListStreamsRequest(*ivs.ListStreamsInput) (*request.Request, *ivs.ListStreamsOutput) diff --git a/service/kafka/api.go b/service/kafka/api.go index f03756b3b5..72784aaf1d 100644 --- a/service/kafka/api.go +++ b/service/kafka/api.go @@ -1782,7 +1782,7 @@ func (c *Kafka) ListKafkaVersionsRequest(input *ListKafkaVersionsInput) (req *re // ListKafkaVersions API operation for Managed Streaming for Kafka. // -// Returns a list of Kafka versions. +// Returns a list of Apache Kafka versions. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -3098,6 +3098,103 @@ func (c *Kafka) UpdateConfigurationWithContext(ctx aws.Context, input *UpdateCon return out, req.Send() } +const opUpdateConnectivity = "UpdateConnectivity" + +// UpdateConnectivityRequest generates a "aws/request.Request" representing the +// client's request for the UpdateConnectivity operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateConnectivity for more information on using the UpdateConnectivity +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateConnectivityRequest method. +// req, resp := client.UpdateConnectivityRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/UpdateConnectivity +func (c *Kafka) UpdateConnectivityRequest(input *UpdateConnectivityInput) (req *request.Request, output *UpdateConnectivityOutput) { + op := &request.Operation{ + Name: opUpdateConnectivity, + HTTPMethod: "PUT", + HTTPPath: "/v1/clusters/{clusterArn}/connectivity", + } + + if input == nil { + input = &UpdateConnectivityInput{} + } + + output = &UpdateConnectivityOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateConnectivity API operation for Managed Streaming for Kafka. +// +// Updates the connectivity configuration for the cluster. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Managed Streaming for Kafka's +// API operation UpdateConnectivity for usage and error information. +// +// Returned Error Types: +// * BadRequestException +// Returns information about an error. +// +// * UnauthorizedException +// Returns information about an error. +// +// * InternalServerErrorException +// Returns information about an error. +// +// * ForbiddenException +// Returns information about an error. +// +// * NotFoundException +// Returns information about an error. +// +// * ServiceUnavailableException +// Returns information about an error. +// +// * TooManyRequestsException +// Returns information about an error. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/kafka-2018-11-14/UpdateConnectivity +func (c *Kafka) UpdateConnectivity(input *UpdateConnectivityInput) (*UpdateConnectivityOutput, error) { + req, out := c.UpdateConnectivityRequest(input) + return out, req.Send() +} + +// UpdateConnectivityWithContext is the same as UpdateConnectivity with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateConnectivity for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *Kafka) UpdateConnectivityWithContext(ctx aws.Context, input *UpdateConnectivityInput, opts ...request.Option) (*UpdateConnectivityOutput, error) { + req, out := c.UpdateConnectivityRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opUpdateMonitoring = "UpdateMonitoring" // UpdateMonitoringRequest generates a "aws/request.Request" representing the @@ -3700,7 +3797,7 @@ func (s *BrokerLogs) SetS3(v *S3) *BrokerLogs { return s } -// Describes the setup to be used for Kafka broker nodes in the cluster. +// Describes the setup to be used for Apache Kafka broker nodes in the cluster. type BrokerNodeGroupInfo struct { _ struct{} `type:"structure"` @@ -3715,6 +3812,9 @@ type BrokerNodeGroupInfo struct { // ClientSubnets is a required field ClientSubnets []*string `locationName:"clientSubnets" type:"list" required:"true"` + // Information about the broker access configuration. + ConnectivityInfo *ConnectivityInfo `locationName:"connectivityInfo" type:"structure"` + // The type of broker used in the Amazon MSK cluster. // // InstanceType is a required field @@ -3786,6 +3886,12 @@ func (s *BrokerNodeGroupInfo) SetClientSubnets(v []*string) *BrokerNodeGroupInfo return s } +// SetConnectivityInfo sets the ConnectivityInfo field's value. +func (s *BrokerNodeGroupInfo) SetConnectivityInfo(v *ConnectivityInfo) *BrokerNodeGroupInfo { + s.ConnectivityInfo = v + return s +} + // SetInstanceType sets the InstanceType field's value. func (s *BrokerNodeGroupInfo) SetInstanceType(v string) *BrokerNodeGroupInfo { s.InstanceType = &v @@ -3820,8 +3926,8 @@ type BrokerNodeInfo struct { // The virtual private cloud (VPC) of the client. ClientVpcIpAddress *string `locationName:"clientVpcIpAddress" type:"string"` - // Information about the version of software currently deployed on the Kafka - // brokers in the cluster. + // Information about the version of software currently deployed on the Apache + // Kafka brokers in the cluster. CurrentBrokerSoftwareInfo *BrokerSoftwareInfo `locationName:"currentBrokerSoftwareInfo" type:"structure"` // Endpoints for accessing the broker. @@ -4061,8 +4167,8 @@ type ClusterInfo struct { // The time when the cluster was created. CreationTime *time.Time `locationName:"creationTime" type:"timestamp" timestampFormat:"iso8601"` - // Information about the version of software currently deployed on the Kafka - // brokers in the cluster. + // Information about the version of software currently deployed on the Apache + // Kafka brokers in the cluster. CurrentBrokerSoftwareInfo *BrokerSoftwareInfo `locationName:"currentBrokerSoftwareInfo" type:"structure"` // The current version of the MSK cluster. Cluster versions aren't simple integers. @@ -4428,7 +4534,8 @@ func (s *ClusterOperationStepInfo) SetStepStatus(v string) *ClusterOperationStep return s } -// Contains source Kafka versions and compatible target Kafka versions. +// Contains source Apache Kafka versions and compatible target Apache Kafka +// versions. type CompatibleKafkaVersion struct { _ struct{} `type:"structure"` @@ -4749,6 +4856,38 @@ func (s *ConflictException) RequestID() string { return s.RespMetadata.RequestID } +// Information about the broker access configuration. +type ConnectivityInfo struct { + _ struct{} `type:"structure"` + + // Public access control for brokers. + PublicAccess *PublicAccess `locationName:"publicAccess" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConnectivityInfo) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConnectivityInfo) GoString() string { + return s.String() +} + +// SetPublicAccess sets the PublicAccess field's value. +func (s *ConnectivityInfo) SetPublicAccess(v *PublicAccess) *ConnectivityInfo { + s.PublicAccess = v + return s +} + // Creates a cluster. type CreateClusterInput struct { _ struct{} `type:"structure"` @@ -4784,7 +4923,7 @@ type CreateClusterInput struct { // LoggingInfo details. LoggingInfo *LoggingInfo `locationName:"loggingInfo" type:"structure"` - // The number of Kafka broker nodes in the Amazon MSK cluster. + // The number of Apache Kafka broker nodes in the Amazon MSK cluster. // // NumberOfBrokerNodes is a required field NumberOfBrokerNodes *int64 `locationName:"numberOfBrokerNodes" min:"1" type:"integer" required:"true"` @@ -5746,8 +5885,8 @@ func (s *DescribeConfigurationRevisionOutput) SetServerProperties(v []byte) *Des return s } -// Contains information about the EBS storage volumes attached to Kafka broker -// nodes. +// Contains information about the EBS storage volumes attached to Apache Kafka +// broker nodes. type EBSStorageInfo struct { _ struct{} `type:"structure"` @@ -6173,18 +6312,33 @@ type GetBootstrapBrokersOutput struct { // A string containing one or more hostname:port pairs. BootstrapBrokerString *string `locationName:"bootstrapBrokerString" type:"string"` + // A string that contains one or more DNS names (or IP addresses) and SASL IAM + // port pairs. The following is an example. + // { "BootstrapBrokerStringSaslIam": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9198"} + BootstrapBrokerStringPublicSaslIam *string `locationName:"bootstrapBrokerStringPublicSaslIam" type:"string"` + + // A string containing one or more DNS names (or IP addresses) and SASL SCRAM + // port pairs. The following is an example. + // { "BootstrapBrokerStringSaslScram": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9196"} + BootstrapBrokerStringPublicSaslScram *string `locationName:"bootstrapBrokerStringPublicSaslScram" type:"string"` + + // A string containing one or more DNS names (or IP addresses) and TLS port + // pairs. The following is an example. + // { "BootstrapBrokerStringTls": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9194"} + BootstrapBrokerStringPublicTls *string `locationName:"bootstrapBrokerStringPublicTls" type:"string"` + // A string that contains one or more DNS names (or IP addresses) and SASL IAM // port pairs. The following is an example. // { "BootstrapBrokerStringSaslIam": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9098"} BootstrapBrokerStringSaslIam *string `locationName:"bootstrapBrokerStringSaslIam" type:"string"` - // A string containing one or more DNS names (or IP) and SASL SCRAM port pairs. - // The following is an example. + // A string containing one or more DNS names (or IP addresses) and SASL SCRAM + // port pairs. The following is an example. // { "BootstrapBrokerStringSaslScram": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9096"} BootstrapBrokerStringSaslScram *string `locationName:"bootstrapBrokerStringSaslScram" type:"string"` - // A string containing one or more DNS names (or IP) and TLS port pairs. The - // following is an example. + // A string containing one or more DNS names (or IP addresses) and TLS port + // pairs. The following is an example. // { "BootstrapBrokerStringTls": "b-3.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-1.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094,b-2.exampleClusterName.abcde.c2.kafka.us-east-1.amazonaws.com:9094"} BootstrapBrokerStringTls *string `locationName:"bootstrapBrokerStringTls" type:"string"` } @@ -6213,6 +6367,24 @@ func (s *GetBootstrapBrokersOutput) SetBootstrapBrokerString(v string) *GetBoots return s } +// SetBootstrapBrokerStringPublicSaslIam sets the BootstrapBrokerStringPublicSaslIam field's value. +func (s *GetBootstrapBrokersOutput) SetBootstrapBrokerStringPublicSaslIam(v string) *GetBootstrapBrokersOutput { + s.BootstrapBrokerStringPublicSaslIam = &v + return s +} + +// SetBootstrapBrokerStringPublicSaslScram sets the BootstrapBrokerStringPublicSaslScram field's value. +func (s *GetBootstrapBrokersOutput) SetBootstrapBrokerStringPublicSaslScram(v string) *GetBootstrapBrokersOutput { + s.BootstrapBrokerStringPublicSaslScram = &v + return s +} + +// SetBootstrapBrokerStringPublicTls sets the BootstrapBrokerStringPublicTls field's value. +func (s *GetBootstrapBrokersOutput) SetBootstrapBrokerStringPublicTls(v string) *GetBootstrapBrokersOutput { + s.BootstrapBrokerStringPublicTls = &v + return s +} + // SetBootstrapBrokerStringSaslIam sets the BootstrapBrokerStringSaslIam field's value. func (s *GetBootstrapBrokersOutput) SetBootstrapBrokerStringSaslIam(v string) *GetBootstrapBrokersOutput { s.BootstrapBrokerStringSaslIam = &v @@ -6470,14 +6642,14 @@ func (s *JmxExporterInfo) SetEnabledInBroker(v bool) *JmxExporterInfo { return s } -// Information about a Kafka version. +// Information about a Apache Kafka version. type KafkaVersion struct { _ struct{} `type:"structure"` // The status of the Apache Kafka version. Status *string `locationName:"status" type:"string" enum:"KafkaVersionStatus"` - // The Kafka version. + // The Apache Kafka version. Version *string `locationName:"version" type:"string"` } @@ -6981,7 +7153,7 @@ func (s *ListKafkaVersionsInput) SetNextToken(v string) *ListKafkaVersionsInput type ListKafkaVersionsOutput struct { _ struct{} `type:"structure"` - // An array of Kafka version objects. + // An array of Apache Kafka version objects. KafkaVersions []*KafkaVersion `locationName:"kafkaVersions" type:"list"` // Paginated results marker. @@ -7381,6 +7553,9 @@ type MutableClusterInfo struct { // Information about the changes in the configuration of the brokers. ConfigurationInfo *ConfigurationInfo `locationName:"configurationInfo" type:"structure"` + // Information about the broker access configuration. + ConnectivityInfo *ConnectivityInfo `locationName:"connectivityInfo" type:"structure"` + // Includes all encryption-related information. EncryptionInfo *EncryptionInfo `locationName:"encryptionInfo" type:"structure"` @@ -7438,6 +7613,12 @@ func (s *MutableClusterInfo) SetConfigurationInfo(v *ConfigurationInfo) *Mutable return s } +// SetConnectivityInfo sets the ConnectivityInfo field's value. +func (s *MutableClusterInfo) SetConnectivityInfo(v *ConnectivityInfo) *MutableClusterInfo { + s.ConnectivityInfo = v + return s +} + // SetEncryptionInfo sets the EncryptionInfo field's value. func (s *MutableClusterInfo) SetEncryptionInfo(v *EncryptionInfo) *MutableClusterInfo { s.EncryptionInfo = v @@ -7892,6 +8073,39 @@ func (s *PrometheusInfo) SetNodeExporter(v *NodeExporterInfo) *PrometheusInfo { return s } +// Broker public access control. +type PublicAccess struct { + _ struct{} `type:"structure"` + + // The value DISABLED indicates that public access is disabled. SERVICE_PROVIDED_EIPS + // indicates that public access is enabled. + Type *string `locationName:"type" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PublicAccess) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PublicAccess) GoString() string { + return s.String() +} + +// SetType sets the Type field's value. +func (s *PublicAccess) SetType(v string) *PublicAccess { + s.Type = &v + return s +} + // Request body for RebootBrokerNode action. type RebootBrokerInput struct { _ struct{} `type:"structure"` @@ -9212,7 +9426,7 @@ type UpdateClusterKafkaVersionInput struct { // CurrentVersion is a required field CurrentVersion *string `locationName:"currentVersion" type:"string" required:"true"` - // Target Kafka version. + // Target Apache Kafka version. // // TargetKafkaVersion is a required field TargetKafkaVersion *string `locationName:"targetKafkaVersion" type:"string" required:"true"` @@ -9442,6 +9656,123 @@ func (s *UpdateConfigurationOutput) SetLatestRevision(v *ConfigurationRevision) return s } +// Request body for UpdateConnectivity. +type UpdateConnectivityInput struct { + _ struct{} `type:"structure"` + + // ClusterArn is a required field + ClusterArn *string `location:"uri" locationName:"clusterArn" type:"string" required:"true"` + + // Information about the broker access configuration. + // + // ConnectivityInfo is a required field + ConnectivityInfo *ConnectivityInfo `locationName:"connectivityInfo" type:"structure" required:"true"` + + // The current version of the cluster. + // + // CurrentVersion is a required field + CurrentVersion *string `locationName:"currentVersion" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateConnectivityInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateConnectivityInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateConnectivityInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateConnectivityInput"} + if s.ClusterArn == nil { + invalidParams.Add(request.NewErrParamRequired("ClusterArn")) + } + if s.ClusterArn != nil && len(*s.ClusterArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClusterArn", 1)) + } + if s.ConnectivityInfo == nil { + invalidParams.Add(request.NewErrParamRequired("ConnectivityInfo")) + } + if s.CurrentVersion == nil { + invalidParams.Add(request.NewErrParamRequired("CurrentVersion")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClusterArn sets the ClusterArn field's value. +func (s *UpdateConnectivityInput) SetClusterArn(v string) *UpdateConnectivityInput { + s.ClusterArn = &v + return s +} + +// SetConnectivityInfo sets the ConnectivityInfo field's value. +func (s *UpdateConnectivityInput) SetConnectivityInfo(v *ConnectivityInfo) *UpdateConnectivityInput { + s.ConnectivityInfo = v + return s +} + +// SetCurrentVersion sets the CurrentVersion field's value. +func (s *UpdateConnectivityInput) SetCurrentVersion(v string) *UpdateConnectivityInput { + s.CurrentVersion = &v + return s +} + +// Response body for UpdateConnectivity. +type UpdateConnectivityOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the cluster. + ClusterArn *string `locationName:"clusterArn" type:"string"` + + // The Amazon Resource Name (ARN) of the cluster operation. + ClusterOperationArn *string `locationName:"clusterOperationArn" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateConnectivityOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateConnectivityOutput) GoString() string { + return s.String() +} + +// SetClusterArn sets the ClusterArn field's value. +func (s *UpdateConnectivityOutput) SetClusterArn(v string) *UpdateConnectivityOutput { + s.ClusterArn = &v + return s +} + +// SetClusterOperationArn sets the ClusterOperationArn field's value. +func (s *UpdateConnectivityOutput) SetClusterOperationArn(v string) *UpdateConnectivityOutput { + s.ClusterOperationArn = &v + return s +} + // Request body for UpdateMonitoring. type UpdateMonitoringInput struct { _ struct{} `type:"structure"` @@ -9817,7 +10148,7 @@ func ClientBroker_Values() []string { } } -// The state of a Kafka cluster. +// The state of an Apache Kafka cluster. const ( // ClusterStateActive is a ClusterState enum value ClusterStateActive = "ACTIVE" @@ -9907,7 +10238,7 @@ func EnhancedMonitoring_Values() []string { } } -// The status of a Kafka version. +// The status of a Apache Kafka version. const ( // KafkaVersionStatusActive is a KafkaVersionStatus enum value KafkaVersionStatusActive = "ACTIVE" diff --git a/service/kafka/kafkaiface/interface.go b/service/kafka/kafkaiface/interface.go index 00aba9a572..28f73397ac 100644 --- a/service/kafka/kafkaiface/interface.go +++ b/service/kafka/kafkaiface/interface.go @@ -197,6 +197,10 @@ type KafkaAPI interface { UpdateConfigurationWithContext(aws.Context, *kafka.UpdateConfigurationInput, ...request.Option) (*kafka.UpdateConfigurationOutput, error) UpdateConfigurationRequest(*kafka.UpdateConfigurationInput) (*request.Request, *kafka.UpdateConfigurationOutput) + UpdateConnectivity(*kafka.UpdateConnectivityInput) (*kafka.UpdateConnectivityOutput, error) + UpdateConnectivityWithContext(aws.Context, *kafka.UpdateConnectivityInput, ...request.Option) (*kafka.UpdateConnectivityOutput, error) + UpdateConnectivityRequest(*kafka.UpdateConnectivityInput) (*request.Request, *kafka.UpdateConnectivityOutput) + UpdateMonitoring(*kafka.UpdateMonitoringInput) (*kafka.UpdateMonitoringOutput, error) UpdateMonitoringWithContext(aws.Context, *kafka.UpdateMonitoringInput, ...request.Option) (*kafka.UpdateMonitoringOutput, error) UpdateMonitoringRequest(*kafka.UpdateMonitoringInput) (*request.Request, *kafka.UpdateMonitoringOutput) diff --git a/service/lambda/api.go b/service/lambda/api.go index ed1bc2bd56..c144d1d387 100644 --- a/service/lambda/api.go +++ b/service/lambda/api.go @@ -464,19 +464,20 @@ func (c *Lambda) CreateEventSourceMappingRequest(input *CreateEventSourceMapping // Creates a mapping between an event source and an Lambda function. Lambda // reads items from the event source and triggers the function. // -// For details about each event source type, see the following topics. +// For details about how to configure different event sources, see the following +// topics. // -// * Configuring a Dynamo DB stream as an event source (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping) +// * Amazon DynamoDB Streams (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping) // -// * Configuring a Kinesis stream as an event source (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping) +// * Amazon Kinesis (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping) // -// * Configuring an Amazon SQS queue as an event source (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource) +// * Amazon SQS (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource) // -// * Configuring an MQ broker as an event source (https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping) +// * Amazon MQ and RabbitMQ (https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping) // -// * Configuring MSK as an event source (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) +// * Amazon MSK (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) // -// * Configuring Self-Managed Apache Kafka as an event source (https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html) +// * Apache Kafka (https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html) // // The following error handling options are only available for stream sources // (DynamoDB and Kinesis): @@ -497,6 +498,21 @@ func (c *Lambda) CreateEventSourceMappingRequest(input *CreateEventSourceMapping // // * ParallelizationFactor - Process multiple batches from each shard concurrently. // +// For information about which configuration parameters apply to each event +// source, see the following topics. +// +// * Amazon DynamoDB Streams (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-params) +// +// * Amazon Kinesis (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-params) +// +// * Amazon SQS (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-params) +// +// * Amazon MQ and RabbitMQ (https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-params) +// +// * Amazon MSK (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-parms) +// +// * Apache Kafka (https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-kafka-parms) +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -5861,6 +5877,21 @@ func (c *Lambda) UpdateEventSourceMappingRequest(input *UpdateEventSourceMapping // Updates an event source mapping. You can change the function that Lambda // invokes, or pause invocation and resume later from the same location. // +// For details about how to configure different event sources, see the following +// topics. +// +// * Amazon DynamoDB Streams (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-dynamodb-eventsourcemapping) +// +// * Amazon Kinesis (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-eventsourcemapping) +// +// * Amazon SQS (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#events-sqs-eventsource) +// +// * Amazon MQ and RabbitMQ (https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-eventsourcemapping) +// +// * Amazon MSK (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html) +// +// * Apache Kafka (https://docs.aws.amazon.com/lambda/latest/dg/kafka-smaa.html) +// // The following error handling options are only available for stream sources // (DynamoDB and Kinesis): // @@ -5880,6 +5911,21 @@ func (c *Lambda) UpdateEventSourceMappingRequest(input *UpdateEventSourceMapping // // * ParallelizationFactor - Process multiple batches from each shard concurrently. // +// For information about which configuration parameters apply to each event +// source, see the following topics. +// +// * Amazon DynamoDB Streams (https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-params) +// +// * Amazon Kinesis (https://docs.aws.amazon.com/lambda/latest/dg/with-kinesis.html#services-kinesis-params) +// +// * Amazon SQS (https://docs.aws.amazon.com/lambda/latest/dg/with-sqs.html#services-sqs-params) +// +// * Amazon MQ and RabbitMQ (https://docs.aws.amazon.com/lambda/latest/dg/with-mq.html#services-mq-params) +// +// * Amazon MSK (https://docs.aws.amazon.com/lambda/latest/dg/with-msk.html#services-msk-parms) +// +// * Apache Kafka (https://docs.aws.amazon.com/lambda/latest/dg/with-kafka.html#services-kafka-parms) +// // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about // the error. @@ -7477,6 +7523,8 @@ type CreateEventSourceMappingInput struct { // * Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000. // // * Self-Managed Apache Kafka - Default 100. Max 10,000. + // + // * Amazon MQ (ActiveMQ and RabbitMQ) - Default 100. Max 10,000. BatchSize *int64 `min:"1" type:"integer"` // (Streams only) If the function returns an error, split the batch in two and @@ -7752,7 +7800,8 @@ type CreateFunctionInput struct { _ struct{} `type:"structure"` // The instruction set architecture that the function supports. Enter a string - // array with one of the valid values. The default value is x86_64. + // array with one of the valid values (arm64 or x86_64). The default value is + // x86_64. Architectures []*string `min:"1" type:"list"` // The code for the function. @@ -7839,9 +7888,9 @@ type CreateFunctionInput struct { // to apply to the function. Tags map[string]*string `type:"map"` - // The amount of time that Lambda allows a function to run before stopping it. - // The default is 3 seconds. The maximum allowed value is 900 seconds. For additional - // information, see Lambda execution environment (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html). + // The amount of time (in seconds) that Lambda allows a function to run before + // stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. + // For additional information, see Lambda execution environment (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html). Timeout *int64 `min:"1" type:"integer"` // Set Mode to Active to sample and trace a subset of incoming requests with @@ -10059,7 +10108,7 @@ type FunctionConfiguration struct { ImageConfigResponse *ImageConfigResponse `type:"structure"` // The KMS key that's used to encrypt the function's environment variables. - // This key is only returned if you've configured a customer managed CMK. + // This key is only returned if you've configured a customer managed key. KMSKeyArn *string `type:"string"` // The date and time that the function was last updated, in ISO-8601 format @@ -10079,7 +10128,7 @@ type FunctionConfiguration struct { // The function's layers (https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html). Layers []*Layer `type:"list"` - // For Lambda@Edge functions, the ARN of the master function. + // For Lambda@Edge functions, the ARN of the main function. MasterArn *string `type:"string"` // The amount of memory available to the function at runtime. @@ -12699,6 +12748,9 @@ type InvokeInput struct { // The JSON that you want to provide to your Lambda function as input. // + // You can enter the JSON directly. For example, --payload '{ "key": "value" + // }'. You can also specify a file path. For example, --payload file://payload.json. + // // Payload is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by InvokeInput's // String and GoString methods. @@ -16732,7 +16784,18 @@ type SourceAccessConfiguration struct { // for SASL SCRAM-512 authentication of your self-managed Apache Kafka brokers. // // * VIRTUAL_HOST - (Amazon MQ) The name of the virtual host in your RabbitMQ - // broker. Lambda uses this RabbitMQ host as the event source. + // broker. Lambda uses this RabbitMQ host as the event source. This property + // cannot be specified in an UpdateEventSourceMapping API call. + // + // * CLIENT_CERTIFICATE_TLS_AUTH - (Amazon MSK, Self-managed Apache Kafka) + // The Secrets Manager ARN of your secret key containing the certificate + // chain (X.509 PEM), private key (PKCS#8 PEM), and private key password + // (optional) used for mutual TLS authentication of your MSK/Apache Kafka + // brokers. + // + // * SERVER_ROOT_CA_CERTIFICATE - (Self-managed Apache Kafka) The Secrets + // Manager ARN of your secret key containing the root CA certificate (X.509 + // PEM) used for TLS encryption of your Apache Kafka brokers. Type *string `type:"string" enum:"SourceAccessType"` // The value for your chosen configuration in Type. For example: "URI": "arn:aws:secretsmanager:us-east-1:01234567890:secret:MyBrokerSecretName". @@ -17473,6 +17536,8 @@ type UpdateEventSourceMappingInput struct { // * Amazon Managed Streaming for Apache Kafka - Default 100. Max 10,000. // // * Self-Managed Apache Kafka - Default 100. Max 10,000. + // + // * Amazon MQ (ActiveMQ and RabbitMQ) - Default 100. Max 10,000. BatchSize *int64 `min:"1" type:"integer"` // (Streams only) If the function returns an error, split the batch in two and @@ -17685,7 +17750,8 @@ type UpdateFunctionCodeInput struct { _ struct{} `type:"structure"` // The instruction set architecture that the function supports. Enter a string - // array with one of the valid values. The default value is x86_64. + // array with one of the valid values (arm64 or x86_64). The default value is + // x86_64. Architectures []*string `min:"1" type:"list"` // Set to true to validate the request parameters and access permissions without @@ -17916,9 +17982,9 @@ type UpdateFunctionConfigurationInput struct { // The identifier of the function's runtime (https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime *string `type:"string" enum:"Runtime"` - // The amount of time that Lambda allows a function to run before stopping it. - // The default is 3 seconds. The maximum allowed value is 900 seconds. For additional - // information, see Lambda execution environment (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html). + // The amount of time (in seconds) that Lambda allows a function to run before + // stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. + // For additional information, see Lambda execution environment (https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html). Timeout *int64 `min:"1" type:"integer"` // Set Mode to Active to sample and trace a subset of incoming requests with @@ -18714,6 +18780,12 @@ const ( // SourceAccessTypeVirtualHost is a SourceAccessType enum value SourceAccessTypeVirtualHost = "VIRTUAL_HOST" + + // SourceAccessTypeClientCertificateTlsAuth is a SourceAccessType enum value + SourceAccessTypeClientCertificateTlsAuth = "CLIENT_CERTIFICATE_TLS_AUTH" + + // SourceAccessTypeServerRootCaCertificate is a SourceAccessType enum value + SourceAccessTypeServerRootCaCertificate = "SERVER_ROOT_CA_CERTIFICATE" ) // SourceAccessType_Values returns all elements of the SourceAccessType enum @@ -18725,6 +18797,8 @@ func SourceAccessType_Values() []string { SourceAccessTypeSaslScram512Auth, SourceAccessTypeSaslScram256Auth, SourceAccessTypeVirtualHost, + SourceAccessTypeClientCertificateTlsAuth, + SourceAccessTypeServerRootCaCertificate, } } diff --git a/service/lambda/doc.go b/service/lambda/doc.go index 33d944e4de..1302ad68df 100644 --- a/service/lambda/doc.go +++ b/service/lambda/doc.go @@ -5,11 +5,72 @@ // // Overview // -// This is the Lambda API Reference. The Lambda Developer Guide provides additional -// information. For the service overview, see What is Lambda (https://docs.aws.amazon.com/lambda/latest/dg/welcome.html), -// and for information about how the service works, see Lambda: How it Works -// (https://docs.aws.amazon.com/lambda/latest/dg/lambda-introduction.html) in -// the Lambda Developer Guide. +// Lambda is a compute service that lets you run code without provisioning or +// managing servers. Lambda runs your code on a high-availability compute infrastructure +// and performs all of the administration of the compute resources, including +// server and operating system maintenance, capacity provisioning and automatic +// scaling, code monitoring and logging. With Lambda, you can run code for virtually +// any type of application or backend service. For more information about the +// Lambda service, see What is Lambda (https://docs.aws.amazon.com/lambda/latest/dg/welcome.html) +// in the Lambda Developer Guide. +// +// The Lambda API Reference provides information about each of the API methods, +// including details about the parameters in each API request and response. +// +// You can use Software Development Kits (SDKs), Integrated Development Environment +// (IDE) Toolkits, and command line tools to access the API. For installation +// instructions, see Tools for Amazon Web Services (http://aws.amazon.com/tools/). +// +// For a list of Region-specific endpoints that Lambda supports, see Lambda +// endpoints and quotas (https://docs.aws.amazon.com/general/latest/gr/lambda-service.html/) +// in the Amazon Web Services General Reference.. +// +// When making the API calls, you will need to authenticate your request by +// providing a signature. Lambda supports signature version 4. For more information, +// see Signature Version 4 signing process (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) +// in the Amazon Web Services General Reference.. +// +// CA certificates +// +// Because Amazon Web Services SDKs use the CA certificates from your computer, +// changes to the certificates on the Amazon Web Services servers can cause +// connection failures when you attempt to use an SDK. You can prevent these +// failures by keeping your computer's CA certificates and operating system +// up-to-date. If you encounter this issue in a corporate environment and do +// not manage your own computer, you might need to ask an administrator to assist +// with the update process. The following list shows minimum operating system +// and Java versions: +// +// * Microsoft Windows versions that have updates from January 2005 or later +// installed contain at least one of the required CAs in their trust list. +// +// * Mac OS X 10.4 with Java for Mac OS X 10.4 Release 5 (February 2007), +// Mac OS X 10.5 (October 2007), and later versions contain at least one +// of the required CAs in their trust list. +// +// * Red Hat Enterprise Linux 5 (March 2007), 6, and 7 and CentOS 5, 6, and +// 7 all contain at least one of the required CAs in their default trusted +// CA list. +// +// * Java 1.4.2_12 (May 2006), 5 Update 2 (March 2005), and all later versions, +// including Java 6 (December 2006), 7, and 8, contain at least one of the +// required CAs in their default trusted CA list. +// +// When accessing the Lambda management console or Lambda API endpoints, whether +// through browsers or programmatically, you will need to ensure your client +// machines support any of the following CAs: +// +// * Amazon Root CA 1 +// +// * Starfield Services Root Certificate Authority - G2 +// +// * Starfield Class 2 Certification Authority +// +// Root certificates from the first two authorities are available from Amazon +// trust services (https://www.amazontrust.com/repository/), but keeping your +// computer up-to-date is the more straightforward solution. To learn more about +// ACM-provided certificates, see Amazon Web Services Certificate Manager FAQs. +// (http://aws.amazon.com/certificate-manager/faqs/#certificates) // // See https://docs.aws.amazon.com/goto/WebAPI/lambda-2015-03-31 for more information on this service. // diff --git a/service/lexmodelsv2/api.go b/service/lexmodelsv2/api.go index 272a2c4a86..fd7400f472 100644 --- a/service/lexmodelsv2/api.go +++ b/service/lexmodelsv2/api.go @@ -1603,7 +1603,8 @@ func (c *LexModelsV2) DeleteBotVersionRequest(input *DeleteBotVersionInput) (req // DeleteBotVersion API operation for Amazon Lex Model Building V2. // // Deletes a specific version of a bot. To delete all version of a bot, use -// the DeleteBot operation. +// the DeleteBot (https://docs.aws.amazon.com/lexv2/latest/dg/API_DeleteBot.html) +// operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2378,8 +2379,9 @@ func (c *LexModelsV2) DeleteUtterancesRequest(input *DeleteUtterancesInput) (req // Deletes stored utterances. // // Amazon Lex stores the utterances that users send to your bot. Utterances -// are stored for 15 days for use with the operation, and then stored indefinitely -// for use in improving the ability of your bot to respond to user input.. +// are stored for 15 days for use with the ListAggregatedUtterances (https://docs.aws.amazon.com/lexv2/latest/dg/API_ListAggregatedUtterances.html) +// operation, and then stored indefinitely for use in improving the ability +// of your bot to respond to user input.. // // Use the DeleteUtterances operation to manually delete utterances for a specific // session. When you use the DeleteUtterances operation, utterances stored for @@ -4163,7 +4165,7 @@ func (c *LexModelsV2) ListBuiltInIntentsRequest(input *ListBuiltInIntentsInput) // // To use a built-in intent as a the base for your own intent, include the built-in // intent signature in the parentIntentSignature parameter when you call the -// CreateIntent operation. For more information, see CreateIntent. +// CreateIntent operation. For more information, see CreateIntent (https://docs.aws.amazon.com/lexv2/latest/dg/API_CreateIntent.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -5853,7 +5855,8 @@ func (c *LexModelsV2) UpdateExportRequest(input *UpdateExportInput) (req *reques // // The password is not required. If you don't supply a password, Amazon Lex // generates a zip file that is not protected by a password. This is the archive -// that is available at the pre-signed S3 URL provided by the operation. +// that is available at the pre-signed S3 URL provided by the DescribeExport +// (https://docs.aws.amazon.com/lexv2/latest/dg/API_DescribeExport.html) operation. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -6537,8 +6540,8 @@ type AudioLogDestination struct { _ struct{} `type:"structure"` // The Amazon S3 bucket where the audio log files are stored. The IAM role specified - // in the roleArn parameter of the CreateBot operation must have permission - // to write to this bucket. + // in the roleArn parameter of the CreateBot (https://docs.aws.amazon.com/lexv2/latest/dg/API_CreateBot.html) + // operation must have permission to write to this bucket. // // S3Bucket is a required field S3Bucket *S3BucketLogDestination `locationName:"s3Bucket" type:"structure" required:"true"` @@ -6769,12 +6772,14 @@ func (s *BotAliasLocaleSettings) SetEnabled(v bool) *BotAliasLocaleSettings { return s } -// Summary information about bot aliases returned from the ListBotAliases operation. +// Summary information about bot aliases returned from the ListBotAliases (https://docs.aws.amazon.com/lexv2/latest/dg/API_ListBotAliases.html) +// operation. type BotAliasSummary struct { _ struct{} `type:"structure"` // The unique identifier assigned to the bot alias. You can use this ID to get - // detailed information about the alias using the DescribeBotAlias operation. + // detailed information about the alias using the DescribeBotAlias (https://docs.aws.amazon.com/lexv2/latest/dg/API_DescribeBotAlias.html) + // operation. BotAliasId *string `locationName:"botAliasId" min:"10" type:"string"` // The name of the bot alias. @@ -7528,7 +7533,8 @@ func (s *BotLocaleSortBy) SetOrder(v string) *BotLocaleSortBy { return s } -// Summary information about bot locales returned by the ListBotLocales operation. +// Summary information about bot locales returned by the ListBotLocales (https://docs.aws.amazon.com/lexv2/latest/dg/API_ListBotLocales.html) +// operation. type BotLocaleSummary struct { _ struct{} `type:"structure"` @@ -7667,12 +7673,14 @@ func (s *BotSortBy) SetOrder(v string) *BotSortBy { return s } -// Summary information about a bot returned by the ListBots operation. +// Summary information about a bot returned by the ListBots (https://docs.aws.amazon.com/lexv2/latest/dg/API_ListBots.html) +// operation. type BotSummary struct { _ struct{} `type:"structure"` // The unique identifier assigned to the bot. Use this ID to get detailed information - // about the bot with the DescribeBot operation. + // about the bot with the DescribeBot (https://docs.aws.amazon.com/lexv2/latest/dg/API_DescribeBot.html) + // operation. BotId *string `locationName:"botId" min:"10" type:"string"` // The name of the bot. @@ -7857,7 +7865,8 @@ func (s *BotVersionSortBy) SetOrder(v string) *BotVersionSortBy { return s } -// Summary information about a bot version returned by the ListBotVersions operation. +// Summary information about a bot version returned by the ListBotVersions (https://docs.aws.amazon.com/lexv2/latest/dg/API_ListBotVersions.html) +// operation. type BotVersionSummary struct { _ struct{} `type:"structure"` @@ -7931,7 +7940,8 @@ type BuildBotLocaleInput struct { _ struct{} `type:"structure" nopayload:"true"` // The identifier of the bot to build. The identifier is returned in the response - // from the operation. + // from the CreateBot (https://docs.aws.amazon.com/lexv2/latest/dg/API_CreateBot.html) + // operation. // // BotId is a required field BotId *string `location:"uri" locationName:"botId" min:"10" type:"string" required:"true"` @@ -8149,6 +8159,7 @@ func (s *BuiltInIntentSortBy) SetOrder(v string) *BuiltInIntentSortBy { } // Provides summary information about a built-in intent for the ListBuiltInIntents +// (https://docs.aws.amazon.com/lexv2/latest/dg/API_ListBuiltInIntents.html) // operation. type BuiltInIntentSummary struct { _ struct{} `type:"structure"` @@ -8253,6 +8264,7 @@ func (s *BuiltInSlotTypeSortBy) SetOrder(v string) *BuiltInSlotTypeSortBy { } // Provides summary information about a built-in slot type for the ListBuiltInSlotTypes +// (https://docs.aws.amazon.com/lexv2/latest/dg/API_ListBuiltInSlotTypes.html) // operation. type BuiltInSlotTypeSummary struct { _ struct{} `type:"structure"` @@ -8646,7 +8658,8 @@ type CreateBotAliasInput struct { // BotId is a required field BotId *string `location:"uri" locationName:"botId" min:"10" type:"string" required:"true"` - // The version of the bot that this alias points to. You can use the operation + // The version of the bot that this alias points to. You can use the UpdateBotAlias + // (https://docs.aws.amazon.com/lexv2/latest/dg/API_UpdateBotAlias.html) operation // to change the bot version associated with the alias. BotVersion *string `locationName:"botVersion" min:"1" type:"string"` @@ -9681,7 +9694,8 @@ type CreateExportOutput struct { // An identifier for a specific request to create an export. ExportId *string `locationName:"exportId" min:"10" type:"string"` - // The status of the export. When the status is Completed, you can use the operation + // The status of the export. When the status is Completed, you can use the DescribeExport + // (https://docs.aws.amazon.com/latest/dg/API_DescribeExport.html) operation // to get the pre-signed S3 URL link to your exported bot or bot locale. ExportStatus *string `locationName:"exportStatus" type:"string" enum:"ExportStatus"` @@ -11170,7 +11184,8 @@ func (s CreateUploadUrlInput) GoString() string { type CreateUploadUrlOutput struct { _ struct{} `type:"structure"` - // An identifier for a unique import job. Use it when you call the operation. + // An identifier for a unique import job. Use it when you call the StartImport + // (https://docs.aws.amazon.com/lexv2/latest/dg/API_StartImport.html) operation. ImportId *string `locationName:"importId" min:"10" type:"string"` // A pre-signed S3 write URL. Upload the zip archive file that contains the @@ -11883,8 +11898,9 @@ type DeleteExportOutput struct { ExportId *string `locationName:"exportId" min:"10" type:"string"` // The current status of the deletion. When the deletion is complete, the export - // will no longer be returned by the operation and calls to the with the export - // identifier will fail. + // will no longer be returned by the ListExports (https://docs.aws.amazon.com/lexv2/latest/dg/API_ListExports.html) + // operation and calls to the DescribeExport (https://docs.aws.amazon.com/lexv2/latest/dg/API_DescribeExport.html) + // operation with the export identifier will fail. ExportStatus *string `locationName:"exportStatus" type:"string" enum:"ExportStatus"` } @@ -11974,8 +11990,9 @@ type DeleteImportOutput struct { ImportId *string `locationName:"importId" min:"10" type:"string"` // The current status of the deletion. When the deletion is complete, the import - // will no longer be returned by the operation and calls to the with the import - // identifier will fail. + // will no longer be returned by the ListImports (https://docs.aws.amazon.com/lexv2/latest/dg/API_ListImports.html) + // operation and calls to the DescribeImport (https://docs.aws.amazon.com/lexv2/latest/dg/API_DescribeImport.html) + // operation with the import identifier will fail. ImportStatus *string `locationName:"importStatus" type:"string" enum:"ImportStatus"` } @@ -12661,7 +12678,9 @@ type DeleteUtterancesInput struct { LocaleId *string `location:"querystring" locationName:"localeId" type:"string"` // The unique identifier of the session with the user. The ID is returned in - // the response from the and operations. + // the response from the RecognizeText (https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_RecognizeText.html) + // and RecognizeUtterance (https://docs.aws.amazon.com/lexv2/latest/dg/API_runtime_RecognizeUtterance.html) + // operations. SessionId *string `location:"querystring" locationName:"sessionId" min:"2" type:"string"` } @@ -14758,7 +14777,8 @@ func (s *DialogCodeHookSettings) SetEnabled(v bool) *DialogCodeHookSettings { return s } -// Filters the response form the operation +// Filters the response form the ListExports (https://docs.aws.amazon.com/lexv2/latest/dg/API_ListExports.html) +// operation type ExportFilter struct { _ struct{} `type:"structure"` @@ -15499,7 +15519,8 @@ func (s *ImageResponseCard) SetTitle(v string) *ImageResponseCard { return s } -// Filters the response from the operation. +// Filters the response from the ListImports (https://docs.aws.amazon.com/lexv2/latest/dg/API_ListImports.html) +// operation. type ImportFilter struct { _ struct{} `type:"structure"` @@ -20984,7 +21005,8 @@ type StartImportInput struct { FilePassword *string `locationName:"filePassword" min:"1" type:"string" sensitive:"true"` // The unique identifier for the import. It is included in the response from - // the operation. + // the CreateUploadUrl (https://docs.aws.amazon.com/lexv2/latest/dg/API_CreateUploadUrl.html) + // operation. // // ImportId is a required field ImportId *string `locationName:"importId" min:"10" type:"string" required:"true"` @@ -21895,7 +21917,8 @@ type UpdateBotInput struct { _ struct{} `type:"structure"` // The unique identifier of the bot to update. This identifier is returned by - // the CreateBot operation. + // the CreateBot (https://docs.aws.amazon.com/lexv2/latest/dg/API_CreateBot.html) + // operation. // // BotId is a required field BotId *string `location:"uri" locationName:"botId" min:"10" type:"string" required:"true"` @@ -23917,6 +23940,11 @@ func (s *ValidationException) RequestID() string { type VoiceSettings struct { _ struct{} `type:"structure"` + // Indicates the type of Amazon Polly voice that Amazon Lex should use for voice + // interaction with the user. For more information, see Voices in Amazon Polly + // (https://docs.aws.amazon.com/polly/latest/dg/voicelist.html). + Engine *string `locationName:"engine" type:"string" enum:"VoiceEngine"` + // The identifier of the Amazon Polly voice to use. // // VoiceId is a required field @@ -23954,6 +23982,12 @@ func (s *VoiceSettings) Validate() error { return nil } +// SetEngine sets the Engine field's value. +func (s *VoiceSettings) SetEngine(v string) *VoiceSettings { + s.Engine = &v + return s +} + // SetVoiceId sets the VoiceId field's value. func (s *VoiceSettings) SetVoiceId(v string) *VoiceSettings { s.VoiceId = &v @@ -24707,3 +24741,19 @@ func TimeDimension_Values() []string { TimeDimensionWeeks, } } + +const ( + // VoiceEngineStandard is a VoiceEngine enum value + VoiceEngineStandard = "standard" + + // VoiceEngineNeural is a VoiceEngine enum value + VoiceEngineNeural = "neural" +) + +// VoiceEngine_Values returns all elements of the VoiceEngine enum +func VoiceEngine_Values() []string { + return []string{ + VoiceEngineStandard, + VoiceEngineNeural, + } +} diff --git a/service/redshiftdataapiservice/api.go b/service/redshiftdataapiservice/api.go index a959dd442d..eb32b095ea 100644 --- a/service/redshiftdataapiservice/api.go +++ b/service/redshiftdataapiservice/api.go @@ -60,16 +60,13 @@ func (c *RedshiftDataAPIService) BatchExecuteStatementRequest(input *BatchExecut // (DML) or data definition language (DDL). Depending on the authorization method, // use one of the following combinations of request parameters: // -// * Secrets Manager - when connecting to a cluster, specify the Amazon Resource -// Name (ARN) of the secret, the database name, and the cluster identifier -// that matches the cluster in the secret. When connecting to a serverless -// endpoint, specify the Amazon Resource Name (ARN) of the secret and the -// database name. +// * Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, +// the database name, and the cluster identifier that matches the cluster +// in the secret. // -// * Temporary credentials - when connecting to a cluster, specify the cluster -// identifier, the database name, and the database user name. Also, permission -// to call the redshift:GetClusterCredentials operation is required. When -// connecting to a serverless endpoint, specify the database name. +// * Temporary credentials - specify the cluster identifier, the database +// name, and the database user name. Permission to call the redshift:GetClusterCredentials +// operation is required to use this method. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -173,9 +170,6 @@ func (c *RedshiftDataAPIService) CancelStatementRequest(input *CancelStatementIn // * InternalServerException // The Amazon Redshift Data API operation failed due to invalid input. // -// * DatabaseConnectionException -// Connection to a database failed. -// // See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/CancelStatement func (c *RedshiftDataAPIService) CancelStatement(input *CancelStatementInput) (*CancelStatementOutput, error) { req, out := c.CancelStatementRequest(input) @@ -341,16 +335,13 @@ func (c *RedshiftDataAPIService) DescribeTableRequest(input *DescribeTableInput) // the column list. Depending on the authorization method, use one of the following // combinations of request parameters: // -// * Secrets Manager - when connecting to a cluster, specify the Amazon Resource -// Name (ARN) of the secret, the database name, and the cluster identifier -// that matches the cluster in the secret. When connecting to a serverless -// endpoint, specify the Amazon Resource Name (ARN) of the secret and the -// database name. +// * Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, +// the database name, and the cluster identifier that matches the cluster +// in the secret. // -// * Temporary credentials - when connecting to a cluster, specify the cluster -// identifier, the database name, and the database user name. Also, permission -// to call the redshift:GetClusterCredentials operation is required. When -// connecting to a serverless endpoint, specify the database name. +// * Temporary credentials - specify the cluster identifier, the database +// name, and the database user name. Permission to call the redshift:GetClusterCredentials +// operation is required to use this method. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -366,9 +357,6 @@ func (c *RedshiftDataAPIService) DescribeTableRequest(input *DescribeTableInput) // * InternalServerException // The Amazon Redshift Data API operation failed due to invalid input. // -// * DatabaseConnectionException -// Connection to a database failed. -// // See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/DescribeTable func (c *RedshiftDataAPIService) DescribeTable(input *DescribeTableInput) (*DescribeTableOutput, error) { req, out := c.DescribeTableRequest(input) @@ -492,16 +480,13 @@ func (c *RedshiftDataAPIService) ExecuteStatementRequest(input *ExecuteStatement // Depending on the authorization method, use one of the following combinations // of request parameters: // -// * Secrets Manager - when connecting to a cluster, specify the Amazon Resource -// Name (ARN) of the secret, the database name, and the cluster identifier -// that matches the cluster in the secret. When connecting to a serverless -// endpoint, specify the Amazon Resource Name (ARN) of the secret and the -// database name. +// * Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, +// the database name, and the cluster identifier that matches the cluster +// in the secret. // -// * Temporary credentials - when connecting to a cluster, specify the cluster -// identifier, the database name, and the database user name. Also, permission -// to call the redshift:GetClusterCredentials operation is required. When -// connecting to a serverless endpoint, specify the database name. +// * Temporary credentials - specify the cluster identifier, the database +// name, and the database user name. Permission to call the redshift:GetClusterCredentials +// operation is required to use this method. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -740,16 +725,13 @@ func (c *RedshiftDataAPIService) ListDatabasesRequest(input *ListDatabasesInput) // database list. Depending on the authorization method, use one of the following // combinations of request parameters: // -// * Secrets Manager - when connecting to a cluster, specify the Amazon Resource -// Name (ARN) of the secret, the database name, and the cluster identifier -// that matches the cluster in the secret. When connecting to a serverless -// endpoint, specify the Amazon Resource Name (ARN) of the secret and the -// database name. +// * Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, +// the database name, and the cluster identifier that matches the cluster +// in the secret. // -// * Temporary credentials - when connecting to a cluster, specify the cluster -// identifier, the database name, and the database user name. Also, permission -// to call the redshift:GetClusterCredentials operation is required. When -// connecting to a serverless endpoint, specify the database name. +// * Temporary credentials - specify the cluster identifier, the database +// name, and the database user name. Permission to call the redshift:GetClusterCredentials +// operation is required to use this method. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -765,9 +747,6 @@ func (c *RedshiftDataAPIService) ListDatabasesRequest(input *ListDatabasesInput) // * InternalServerException // The Amazon Redshift Data API operation failed due to invalid input. // -// * DatabaseConnectionException -// Connection to a database failed. -// // See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListDatabases func (c *RedshiftDataAPIService) ListDatabases(input *ListDatabasesInput) (*ListDatabasesOutput, error) { req, out := c.ListDatabasesRequest(input) @@ -896,16 +875,13 @@ func (c *RedshiftDataAPIService) ListSchemasRequest(input *ListSchemasInput) (re // schema list. Depending on the authorization method, use one of the following // combinations of request parameters: // -// * Secrets Manager - when connecting to a cluster, specify the Amazon Resource -// Name (ARN) of the secret, the database name, and the cluster identifier -// that matches the cluster in the secret. When connecting to a serverless -// endpoint, specify the Amazon Resource Name (ARN) of the secret and the -// database name. +// * Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, +// the database name, and the cluster identifier that matches the cluster +// in the secret. // -// * Temporary credentials - when connecting to a cluster, specify the cluster -// identifier, the database name, and the database user name. Also, permission -// to call the redshift:GetClusterCredentials operation is required. When -// connecting to a serverless endpoint, specify the database name. +// * Temporary credentials - specify the cluster identifier, the database +// name, and the database user name. Permission to call the redshift:GetClusterCredentials +// operation is required to use this method. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -921,9 +897,6 @@ func (c *RedshiftDataAPIService) ListSchemasRequest(input *ListSchemasInput) (re // * InternalServerException // The Amazon Redshift Data API operation failed due to invalid input. // -// * DatabaseConnectionException -// Connection to a database failed. -// // See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListSchemas func (c *RedshiftDataAPIService) ListSchemas(input *ListSchemasInput) (*ListSchemasOutput, error) { req, out := c.ListSchemasRequest(input) @@ -1194,16 +1167,13 @@ func (c *RedshiftDataAPIService) ListTablesRequest(input *ListTablesInput) (req // to page through the table list. Depending on the authorization method, use // one of the following combinations of request parameters: // -// * Secrets Manager - when connecting to a cluster, specify the Amazon Resource -// Name (ARN) of the secret, the database name, and the cluster identifier -// that matches the cluster in the secret. When connecting to a serverless -// endpoint, specify the Amazon Resource Name (ARN) of the secret and the -// database name. +// * Secrets Manager - specify the Amazon Resource Name (ARN) of the secret, +// the database name, and the cluster identifier that matches the cluster +// in the secret. // -// * Temporary credentials - when connecting to a cluster, specify the cluster -// identifier, the database name, and the database user name. Also, permission -// to call the redshift:GetClusterCredentials operation is required. When -// connecting to a serverless endpoint, specify the database name. +// * Temporary credentials - specify the cluster identifier, the database +// name, and the database user name. Permission to call the redshift:GetClusterCredentials +// operation is required to use this method. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1219,9 +1189,6 @@ func (c *RedshiftDataAPIService) ListTablesRequest(input *ListTablesInput) (req // * InternalServerException // The Amazon Redshift Data API operation failed due to invalid input. // -// * DatabaseConnectionException -// Connection to a database failed. -// // See also, https://docs.aws.amazon.com/goto/WebAPI/redshift-data-2019-12-20/ListTables func (c *RedshiftDataAPIService) ListTables(input *ListTablesInput) (*ListTablesOutput, error) { req, out := c.ListTablesRequest(input) @@ -1432,9 +1399,11 @@ func (s *BatchExecuteStatementException) RequestID() string { type BatchExecuteStatementInput struct { _ struct{} `type:"structure"` - // The cluster identifier. This parameter is required when connecting to a cluster - // and authenticating using either Secrets Manager or temporary credentials. - ClusterIdentifier *string `type:"string"` + // The cluster identifier. This parameter is required when authenticating using + // either Secrets Manager or temporary credentials. + // + // ClusterIdentifier is a required field + ClusterIdentifier *string `type:"string" required:"true"` // The name of the database. This parameter is required when authenticating // using either Secrets Manager or temporary credentials. @@ -1442,8 +1411,8 @@ type BatchExecuteStatementInput struct { // Database is a required field Database *string `type:"string" required:"true"` - // The database user name. This parameter is required when connecting to a cluster - // and authenticating using temporary credentials. + // The database user name. This parameter is required when authenticating using + // temporary credentials. DbUser *string `type:"string"` // The name or ARN of the secret that enables access to the database. This parameter @@ -1485,6 +1454,9 @@ func (s BatchExecuteStatementInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *BatchExecuteStatementInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "BatchExecuteStatementInput"} + if s.ClusterIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ClusterIdentifier")) + } if s.Database == nil { invalidParams.Add(request.NewErrParamRequired("Database")) } @@ -1546,8 +1518,7 @@ func (s *BatchExecuteStatementInput) SetWithEvent(v bool) *BatchExecuteStatement type BatchExecuteStatementOutput struct { _ struct{} `type:"structure"` - // The cluster identifier. This parameter is not returned when connecting to - // a serverless endpoint. + // The cluster identifier. ClusterIdentifier *string `type:"string"` // The date and time (UTC) the statement was created. @@ -1841,70 +1812,6 @@ func (s *ColumnMetadata) SetTypeName(v string) *ColumnMetadata { return s } -// Connection to a database failed. -type DatabaseConnectionException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` - - Message_ *string `locationName:"Message" type:"string"` -} - -// String returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DatabaseConnectionException) String() string { - return awsutil.Prettify(s) -} - -// GoString returns the string representation. -// -// API parameter values that are decorated as "sensitive" in the API will not -// be included in the string output. The member name will be present, but the -// value will be replaced with "sensitive". -func (s DatabaseConnectionException) GoString() string { - return s.String() -} - -func newErrorDatabaseConnectionException(v protocol.ResponseMetadata) error { - return &DatabaseConnectionException{ - RespMetadata: v, - } -} - -// Code returns the exception type name. -func (s *DatabaseConnectionException) Code() string { - return "DatabaseConnectionException" -} - -// Message returns the exception's message. -func (s *DatabaseConnectionException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" -} - -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *DatabaseConnectionException) OrigErr() error { - return nil -} - -func (s *DatabaseConnectionException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) -} - -// Status code returns the HTTP status code for the request's response error. -func (s *DatabaseConnectionException) StatusCode() int { - return s.RespMetadata.StatusCode -} - -// RequestID returns the service's response RequestID for request. -func (s *DatabaseConnectionException) RequestID() string { - return s.RespMetadata.RequestID -} - type DescribeStatementInput struct { _ struct{} `type:"structure"` @@ -1979,8 +1886,7 @@ type DescribeStatementOutput struct { Error *string `type:"string"` // A value that indicates whether the statement has a result set. The result - // set can be empty. The value is true for an empty result set. The value is - // true if any substatement returns a result set. + // set can be empty. HasResultSet *bool `type:"boolean"` // The identifier of the SQL statement described. This value is a universally @@ -2171,9 +2077,11 @@ func (s *DescribeStatementOutput) SetUpdatedAt(v time.Time) *DescribeStatementOu type DescribeTableInput struct { _ struct{} `type:"structure"` - // The cluster identifier. This parameter is required when connecting to a cluster - // and authenticating using either Secrets Manager or temporary credentials. - ClusterIdentifier *string `type:"string"` + // The cluster identifier. This parameter is required when authenticating using + // either Secrets Manager or temporary credentials. + // + // ClusterIdentifier is a required field + ClusterIdentifier *string `type:"string" required:"true"` // A database name. The connected database is specified when you connect with // your authentication credentials. @@ -2186,8 +2094,8 @@ type DescribeTableInput struct { // Database is a required field Database *string `type:"string" required:"true"` - // The database user name. This parameter is required when connecting to a cluster - // and authenticating using temporary credentials. + // The database user name. This parameter is required when authenticating using + // temporary credentials. DbUser *string `type:"string"` // The maximum number of tables to return in the response. If more tables exist @@ -2237,6 +2145,9 @@ func (s DescribeTableInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *DescribeTableInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "DescribeTableInput"} + if s.ClusterIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ClusterIdentifier")) + } if s.Database == nil { invalidParams.Add(request.NewErrParamRequired("Database")) } @@ -2427,9 +2338,11 @@ func (s *ExecuteStatementException) RequestID() string { type ExecuteStatementInput struct { _ struct{} `type:"structure"` - // The cluster identifier. This parameter is required when connecting to a cluster - // and authenticating using either Secrets Manager or temporary credentials. - ClusterIdentifier *string `type:"string"` + // The cluster identifier. This parameter is required when authenticating using + // either Secrets Manager or temporary credentials. + // + // ClusterIdentifier is a required field + ClusterIdentifier *string `type:"string" required:"true"` // The name of the database. This parameter is required when authenticating // using either Secrets Manager or temporary credentials. @@ -2437,8 +2350,8 @@ type ExecuteStatementInput struct { // Database is a required field Database *string `type:"string" required:"true"` - // The database user name. This parameter is required when connecting to a cluster - // and authenticating using temporary credentials. + // The database user name. This parameter is required when authenticating using + // temporary credentials. DbUser *string `type:"string"` // The parameters for the SQL statement. @@ -2483,6 +2396,9 @@ func (s ExecuteStatementInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *ExecuteStatementInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ExecuteStatementInput"} + if s.ClusterIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ClusterIdentifier")) + } if s.Database == nil { invalidParams.Add(request.NewErrParamRequired("Database")) } @@ -2560,8 +2476,7 @@ func (s *ExecuteStatementInput) SetWithEvent(v bool) *ExecuteStatementInput { type ExecuteStatementOutput struct { _ struct{} `type:"structure"` - // The cluster identifier. This parameter is not returned when connecting to - // a serverless endpoint. + // The cluster identifier. ClusterIdentifier *string `type:"string"` // The date and time (UTC) the statement was created. @@ -2912,9 +2827,11 @@ func (s *InternalServerException) RequestID() string { type ListDatabasesInput struct { _ struct{} `type:"structure"` - // The cluster identifier. This parameter is required when connecting to a cluster - // and authenticating using either Secrets Manager or temporary credentials. - ClusterIdentifier *string `type:"string"` + // The cluster identifier. This parameter is required when authenticating using + // either Secrets Manager or temporary credentials. + // + // ClusterIdentifier is a required field + ClusterIdentifier *string `type:"string" required:"true"` // The name of the database. This parameter is required when authenticating // using either Secrets Manager or temporary credentials. @@ -2922,8 +2839,8 @@ type ListDatabasesInput struct { // Database is a required field Database *string `type:"string" required:"true"` - // The database user name. This parameter is required when connecting to a cluster - // and authenticating using temporary credentials. + // The database user name. This parameter is required when authenticating using + // temporary credentials. DbUser *string `type:"string"` // The maximum number of databases to return in the response. If more databases @@ -2964,6 +2881,9 @@ func (s ListDatabasesInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *ListDatabasesInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ListDatabasesInput"} + if s.ClusterIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ClusterIdentifier")) + } if s.Database == nil { invalidParams.Add(request.NewErrParamRequired("Database")) } @@ -3057,9 +2977,11 @@ func (s *ListDatabasesOutput) SetNextToken(v string) *ListDatabasesOutput { type ListSchemasInput struct { _ struct{} `type:"structure"` - // The cluster identifier. This parameter is required when connecting to a cluster - // and authenticating using either Secrets Manager or temporary credentials. - ClusterIdentifier *string `type:"string"` + // The cluster identifier. This parameter is required when authenticating using + // either Secrets Manager or temporary credentials. + // + // ClusterIdentifier is a required field + ClusterIdentifier *string `type:"string" required:"true"` // A database name. The connected database is specified when you connect with // your authentication credentials. @@ -3072,8 +2994,8 @@ type ListSchemasInput struct { // Database is a required field Database *string `type:"string" required:"true"` - // The database user name. This parameter is required when connecting to a cluster - // and authenticating using temporary credentials. + // The database user name. This parameter is required when authenticating using + // temporary credentials. DbUser *string `type:"string"` // The maximum number of schemas to return in the response. If more schemas @@ -3119,6 +3041,9 @@ func (s ListSchemasInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *ListSchemasInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ListSchemasInput"} + if s.ClusterIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ClusterIdentifier")) + } if s.Database == nil { invalidParams.Add(request.NewErrParamRequired("Database")) } @@ -3366,9 +3291,11 @@ func (s *ListStatementsOutput) SetStatements(v []*StatementData) *ListStatements type ListTablesInput struct { _ struct{} `type:"structure"` - // The cluster identifier. This parameter is required when connecting to a cluster - // and authenticating using either Secrets Manager or temporary credentials. - ClusterIdentifier *string `type:"string"` + // The cluster identifier. This parameter is required when authenticating using + // either Secrets Manager or temporary credentials. + // + // ClusterIdentifier is a required field + ClusterIdentifier *string `type:"string" required:"true"` // A database name. The connected database is specified when you connect with // your authentication credentials. @@ -3381,8 +3308,8 @@ type ListTablesInput struct { // Database is a required field Database *string `type:"string" required:"true"` - // The database user name. This parameter is required when connecting to a cluster - // and authenticating using temporary credentials. + // The database user name. This parameter is required when authenticating using + // temporary credentials. DbUser *string `type:"string"` // The maximum number of tables to return in the response. If more tables exist @@ -3439,6 +3366,9 @@ func (s ListTablesInput) GoString() string { // Validate inspects the fields of the type to determine if they are valid. func (s *ListTablesInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "ListTablesInput"} + if s.ClusterIdentifier == nil { + invalidParams.Add(request.NewErrParamRequired("ClusterIdentifier")) + } if s.Database == nil { invalidParams.Add(request.NewErrParamRequired("Database")) } @@ -3817,7 +3747,7 @@ type SubStatementData struct { Error *string `type:"string"` // A value that indicates whether the statement has a result set. The result - // set can be empty. The value is true for an empty result set. + // set can be empty. HasResultSet *bool `type:"boolean"` // The identifier of the SQL statement. This value is a universally unique identifier diff --git a/service/redshiftdataapiservice/errors.go b/service/redshiftdataapiservice/errors.go index 9f893dc37a..73101095fb 100644 --- a/service/redshiftdataapiservice/errors.go +++ b/service/redshiftdataapiservice/errors.go @@ -20,12 +20,6 @@ const ( // An SQL statement encountered an environmental error while running. ErrCodeBatchExecuteStatementException = "BatchExecuteStatementException" - // ErrCodeDatabaseConnectionException for service response error code - // "DatabaseConnectionException". - // - // Connection to a database failed. - ErrCodeDatabaseConnectionException = "DatabaseConnectionException" - // ErrCodeExecuteStatementException for service response error code // "ExecuteStatementException". // @@ -54,7 +48,6 @@ const ( var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ "ActiveStatementsExceededException": newErrorActiveStatementsExceededException, "BatchExecuteStatementException": newErrorBatchExecuteStatementException, - "DatabaseConnectionException": newErrorDatabaseConnectionException, "ExecuteStatementException": newErrorExecuteStatementException, "InternalServerException": newErrorInternalServerException, "ResourceNotFoundException": newErrorResourceNotFoundException,