From 33def9f04017a2ae7fdd50e857c8016194523f7c Mon Sep 17 00:00:00 2001 From: aws-sdk-go-automation <43143561+aws-sdk-go-automation@users.noreply.github.com> Date: Mon, 22 Aug 2022 11:27:09 -0700 Subject: [PATCH] Release v1.44.82 (2022-08-22) (#4531) Release v1.44.82 (2022-08-22) === ### Service Client Updates * `service/docdb`: Updates service documentation * Update document for volume clone * `service/ec2`: Updates service API * R6a instances are powered by 3rd generation AMD EPYC (Milan) processors delivering all-core turbo frequency of 3.6 GHz. C6id, M6id, and R6id instances are powered by 3rd generation Intel Xeon Scalable processor (Ice Lake) delivering all-core turbo frequency of 3.5 GHz. * `service/forecast`: Updates service API, documentation, and paginators * `service/forecastquery`: Updates service API and documentation * `service/iotsitewise`: Updates service API * `service/models.lex.v2`: Updates service API and documentation * `service/securityhub`: Updates service API and documentation * `service/support-app`: Adds new service --- CHANGELOG.md | 15 + aws/endpoints/defaults.go | 39 + aws/version.go | 2 +- models/apis/docdb/2014-10-31/docs-2.json | 2 +- models/apis/ec2/2016-11-15/api-2.json | 47 +- models/apis/forecast/2018-06-26/api-2.json | 513 +- models/apis/forecast/2018-06-26/docs-2.json | 344 +- .../forecast/2018-06-26/paginators-1.json | 18 + .../apis/forecastquery/2018-06-26/api-2.json | 41 + .../apis/forecastquery/2018-06-26/docs-2.json | 34 +- models/apis/iotsitewise/2019-12-02/api-2.json | 1 + .../apis/models.lex.v2/2020-08-07/api-2.json | 65 +- .../apis/models.lex.v2/2020-08-07/docs-2.json | 20 + models/apis/securityhub/2018-10-26/api-2.json | 148 +- .../apis/securityhub/2018-10-26/docs-2.json | 287 +- models/apis/support-app/2021-08-20/api-2.json | 445 + .../apis/support-app/2021-08-20/docs-2.json | 254 + .../support-app/2021-08-20/examples-1.json | 5 + .../support-app/2021-08-20/paginators-1.json | 12 + models/endpoints/endpoints.json | 25 + service/docdb/api.go | 3 - service/ec2/api.go | 182 +- service/forecastqueryservice/api.go | 233 + .../forecastqueryserviceiface/interface.go | 4 + service/forecastservice/api.go | 14212 ++++++++++------ .../forecastserviceiface/interface.go | 57 + service/iotsitewise/api.go | 3 + service/lexmodelsv2/api.go | 289 + .../lexmodelsv2/lexmodelsv2iface/interface.go | 4 + service/securityhub/api.go | 1576 +- service/supportapp/api.go | 2482 +++ service/supportapp/doc.go | 61 + service/supportapp/errors.go | 73 + service/supportapp/service.go | 106 + .../supportapp/supportappiface/interface.go | 106 + 35 files changed, 16267 insertions(+), 5441 deletions(-) create mode 100644 models/apis/support-app/2021-08-20/api-2.json create mode 100644 models/apis/support-app/2021-08-20/docs-2.json create mode 100644 models/apis/support-app/2021-08-20/examples-1.json create mode 100644 models/apis/support-app/2021-08-20/paginators-1.json create mode 100644 service/supportapp/api.go create mode 100644 service/supportapp/doc.go create mode 100644 service/supportapp/errors.go create mode 100644 service/supportapp/service.go create mode 100644 service/supportapp/supportappiface/interface.go diff --git a/CHANGELOG.md b/CHANGELOG.md index 88833ffc80..fa15a183e6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,18 @@ +Release v1.44.82 (2022-08-22) +=== + +### Service Client Updates +* `service/docdb`: Updates service documentation + * Update document for volume clone +* `service/ec2`: Updates service API + * R6a instances are powered by 3rd generation AMD EPYC (Milan) processors delivering all-core turbo frequency of 3.6 GHz. C6id, M6id, and R6id instances are powered by 3rd generation Intel Xeon Scalable processor (Ice Lake) delivering all-core turbo frequency of 3.5 GHz. +* `service/forecast`: Updates service API, documentation, and paginators +* `service/forecastquery`: Updates service API and documentation +* `service/iotsitewise`: Updates service API +* `service/models.lex.v2`: Updates service API and documentation +* `service/securityhub`: Updates service API and documentation +* `service/support-app`: Adds new service + Release v1.44.81 (2022-08-19) === diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go index ed81d7107f..5868c77b94 100644 --- a/aws/endpoints/defaults.go +++ b/aws/endpoints/defaults.go @@ -1677,6 +1677,9 @@ var awsPartition = partition{ endpointKey{ Region: "ap-southeast-2", }: endpoint{}, + endpointKey{ + Region: "ap-southeast-3", + }: endpoint{}, endpointKey{ Region: "ca-central-1", }: endpoint{}, @@ -12927,6 +12930,15 @@ var awsPartition = partition{ }, Deprecated: boxedTrue, }, + endpointKey{ + Region: "me-central-1-fips", + }: endpoint{ + Hostname: "kms-fips.me-central-1.amazonaws.com", + CredentialScope: credentialScope{ + Region: "me-central-1", + }, + Deprecated: boxedTrue, + }, endpointKey{ Region: "me-south-1", }: endpoint{}, @@ -22017,6 +22029,19 @@ var awsPartition = partition{ }, }, }, + "supportapp": service{ + Endpoints: serviceEndpoints{ + endpointKey{ + Region: "eu-west-1", + }: endpoint{}, + endpointKey{ + Region: "us-east-1", + }: endpoint{}, + endpointKey{ + Region: "us-west-2", + }: endpoint{}, + }, + }, "swf": service{ Endpoints: serviceEndpoints{ endpointKey{ @@ -32529,6 +32554,20 @@ var awsisobPartition = partition{ }: endpoint{}, }, }, + "metering.marketplace": service{ + Defaults: endpointDefaults{ + defaultKey{}: endpoint{ + CredentialScope: credentialScope{ + Service: "aws-marketplace", + }, + }, + }, + Endpoints: serviceEndpoints{ + endpointKey{ + Region: "us-isob-east-1", + }: endpoint{}, + }, + }, "monitoring": service{ Endpoints: serviceEndpoints{ endpointKey{ diff --git a/aws/version.go b/aws/version.go index c15045b52f..49baeb8ba5 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.44.81" +const SDKVersion = "1.44.82" diff --git a/models/apis/docdb/2014-10-31/docs-2.json b/models/apis/docdb/2014-10-31/docs-2.json index 1bde682107..14581e865a 100644 --- a/models/apis/docdb/2014-10-31/docs-2.json +++ b/models/apis/docdb/2014-10-31/docs-2.json @@ -1644,7 +1644,7 @@ "RestoreDBClusterFromSnapshotMessage$DBSubnetGroupName": "

The name of the subnet group to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

", "RestoreDBClusterFromSnapshotMessage$KmsKeyId": "

The KMS key identifier to use when restoring an encrypted cluster from a DB snapshot or cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

", "RestoreDBClusterToPointInTimeMessage$DBClusterIdentifier": "

The name of the new cluster to be created.

Constraints:

", - "RestoreDBClusterToPointInTimeMessage$RestoreType": "

The type of restore to be performed. You can specify one of the following values:

Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

", + "RestoreDBClusterToPointInTimeMessage$RestoreType": "

The type of restore to be performed. You can specify one of the following values:

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

", "RestoreDBClusterToPointInTimeMessage$SourceDBClusterIdentifier": "

The identifier of the source cluster from which to restore.

Constraints:

", "RestoreDBClusterToPointInTimeMessage$DBSubnetGroupName": "

The subnet group name to use for the new cluster.

Constraints: If provided, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

", "RestoreDBClusterToPointInTimeMessage$KmsKeyId": "

The KMS key identifier to use when restoring an encrypted cluster from an encrypted cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a cluster with the same Amazon Web Services account that owns the KMS encryption key used to encrypt the new cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

You can restore to a new cluster and encrypt the new cluster with an KMS key that is different from the KMS key used to encrypt the source cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following occurs:

If DBClusterIdentifier refers to a cluster that is not encrypted, then the restore request is rejected.

", diff --git a/models/apis/ec2/2016-11-15/api-2.json b/models/apis/ec2/2016-11-15/api-2.json index 047377a630..c03b8958fe 100755 --- a/models/apis/ec2/2016-11-15/api-2.json +++ b/models/apis/ec2/2016-11-15/api-2.json @@ -24614,7 +24614,49 @@ "c7g.8xlarge", "c7g.12xlarge", "c7g.16xlarge", - "mac2.metal" + "mac2.metal", + "c6id.large", + "c6id.xlarge", + "c6id.2xlarge", + "c6id.4xlarge", + "c6id.8xlarge", + "c6id.12xlarge", + "c6id.16xlarge", + "c6id.24xlarge", + "c6id.32xlarge", + "c6id.metal", + "m6id.large", + "m6id.xlarge", + "m6id.2xlarge", + "m6id.4xlarge", + "m6id.8xlarge", + "m6id.12xlarge", + "m6id.16xlarge", + "m6id.24xlarge", + "m6id.32xlarge", + "m6id.metal", + "r6id.large", + "r6id.xlarge", + "r6id.2xlarge", + "r6id.4xlarge", + "r6id.8xlarge", + "r6id.12xlarge", + "r6id.16xlarge", + "r6id.24xlarge", + "r6id.32xlarge", + "r6id.metal", + "r6a.large", + "r6a.xlarge", + "r6a.2xlarge", + "r6a.4xlarge", + "r6a.8xlarge", + "r6a.12xlarge", + "r6a.16xlarge", + "r6a.24xlarge", + "r6a.32xlarge", + "r6a.48xlarge", + "r6a.metal", + "p4de.24xlarge" ] }, "InstanceTypeHypervisor":{ @@ -32467,7 +32509,8 @@ "PrivateDnsNameOptions":{"shape":"LaunchTemplatePrivateDnsNameOptionsRequest"}, "MaintenanceOptions":{"shape":"LaunchTemplateInstanceMaintenanceOptionsRequest"}, "DisableApiStop":{"shape":"Boolean"} - } + }, + "sensitive":true }, "RequestSpotFleetRequest":{ "type":"structure", diff --git a/models/apis/forecast/2018-06-26/api-2.json b/models/apis/forecast/2018-06-26/api-2.json index 45a84b2b48..93c8737fcf 100644 --- a/models/apis/forecast/2018-06-26/api-2.json +++ b/models/apis/forecast/2018-06-26/api-2.json @@ -187,6 +187,54 @@ {"shape":"LimitExceededException"} ] }, + "CreateWhatIfAnalysis":{ + "name":"CreateWhatIfAnalysis", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWhatIfAnalysisRequest"}, + "output":{"shape":"CreateWhatIfAnalysisResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"} + ] + }, + "CreateWhatIfForecast":{ + "name":"CreateWhatIfForecast", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWhatIfForecastRequest"}, + "output":{"shape":"CreateWhatIfForecastResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"} + ] + }, + "CreateWhatIfForecastExport":{ + "name":"CreateWhatIfForecastExport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateWhatIfForecastExportRequest"}, + "output":{"shape":"CreateWhatIfForecastExportResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceAlreadyExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"LimitExceededException"} + ] + }, "DeleteDataset":{ "name":"DeleteDataset", "http":{ @@ -341,6 +389,48 @@ ], "idempotent":true }, + "DeleteWhatIfAnalysis":{ + "name":"DeleteWhatIfAnalysis", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWhatIfAnalysisRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "idempotent":true + }, + "DeleteWhatIfForecast":{ + "name":"DeleteWhatIfForecast", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWhatIfForecastRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "idempotent":true + }, + "DeleteWhatIfForecastExport":{ + "name":"DeleteWhatIfForecastExport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteWhatIfForecastExportRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"} + ], + "idempotent":true + }, "DescribeAutoPredictor":{ "name":"DescribeAutoPredictor", "http":{ @@ -495,6 +585,48 @@ ], "idempotent":true }, + "DescribeWhatIfAnalysis":{ + "name":"DescribeWhatIfAnalysis", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWhatIfAnalysisRequest"}, + "output":{"shape":"DescribeWhatIfAnalysisResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, + "DescribeWhatIfForecast":{ + "name":"DescribeWhatIfForecast", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWhatIfForecastRequest"}, + "output":{"shape":"DescribeWhatIfForecastResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, + "DescribeWhatIfForecastExport":{ + "name":"DescribeWhatIfForecastExport", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeWhatIfForecastExportRequest"}, + "output":{"shape":"DescribeWhatIfForecastExportResponse"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, "GetAccuracyMetrics":{ "name":"GetAccuracyMetrics", "http":{ @@ -676,6 +808,48 @@ {"shape":"InvalidInputException"} ] }, + "ListWhatIfAnalyses":{ + "name":"ListWhatIfAnalyses", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWhatIfAnalysesRequest"}, + "output":{"shape":"ListWhatIfAnalysesResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidInputException"} + ], + "idempotent":true + }, + "ListWhatIfForecastExports":{ + "name":"ListWhatIfForecastExports", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWhatIfForecastExportsRequest"}, + "output":{"shape":"ListWhatIfForecastExportsResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidInputException"} + ], + "idempotent":true + }, + "ListWhatIfForecasts":{ + "name":"ListWhatIfForecasts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListWhatIfForecastsRequest"}, + "output":{"shape":"ListWhatIfForecastsResponse"}, + "errors":[ + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidInputException"} + ], + "idempotent":true + }, "ResumeResource":{ "name":"ResumeResource", "http":{ @@ -749,6 +923,19 @@ } }, "shapes":{ + "Action":{ + "type":"structure", + "required":[ + "AttributeName", + "Operation", + "Value" + ], + "members":{ + "AttributeName":{"shape":"Name"}, + "Operation":{"shape":"Operation"}, + "Value":{"shape":"Double"} + } + }, "AdditionalDataset":{ "type":"structure", "required":["Name"], @@ -766,7 +953,7 @@ "Arn":{ "type":"string", "max":256, - "pattern":"^[a-zA-Z0-9\\-\\_\\.\\/\\:]+$" + "pattern":"arn:([a-z\\d-]+):forecast:.*:.*:.+" }, "ArnList":{ "type":"list", @@ -799,6 +986,11 @@ "geolocation" ] }, + "AttributeValue":{ + "type":"string", + "max":256, + "pattern":".+" + }, "AutoMLOverrideStrategy":{ "type":"string", "enum":[ @@ -841,6 +1033,15 @@ "max":20, "min":1 }, + "Condition":{ + "type":"string", + "enum":[ + "EQUALS", + "NOT_EQUALS", + "LESS_THAN", + "GREATER_THAN" + ] + }, "Configuration":{ "type":"map", "key":{"shape":"Name"}, @@ -1117,6 +1318,66 @@ "PredictorArn":{"shape":"Arn"} } }, + "CreateWhatIfAnalysisRequest":{ + "type":"structure", + "required":[ + "WhatIfAnalysisName", + "ForecastArn" + ], + "members":{ + "WhatIfAnalysisName":{"shape":"Name"}, + "ForecastArn":{"shape":"Arn"}, + "TimeSeriesSelector":{"shape":"TimeSeriesSelector"}, + "Tags":{"shape":"Tags"} + } + }, + "CreateWhatIfAnalysisResponse":{ + "type":"structure", + "members":{ + "WhatIfAnalysisArn":{"shape":"Arn"} + } + }, + "CreateWhatIfForecastExportRequest":{ + "type":"structure", + "required":[ + "WhatIfForecastExportName", + "WhatIfForecastArns", + "Destination" + ], + "members":{ + "WhatIfForecastExportName":{"shape":"Name"}, + "WhatIfForecastArns":{"shape":"WhatIfForecastArnListForExport"}, + "Destination":{"shape":"DataDestination"}, + "Tags":{"shape":"Tags"}, + "Format":{"shape":"Format"} + } + }, + "CreateWhatIfForecastExportResponse":{ + "type":"structure", + "members":{ + "WhatIfForecastExportArn":{"shape":"LongArn"} + } + }, + "CreateWhatIfForecastRequest":{ + "type":"structure", + "required":[ + "WhatIfForecastName", + "WhatIfAnalysisArn" + ], + "members":{ + "WhatIfForecastName":{"shape":"Name"}, + "WhatIfAnalysisArn":{"shape":"Arn"}, + "TimeSeriesTransformations":{"shape":"TimeSeriesTransformations"}, + "TimeSeriesReplacementsDataSource":{"shape":"TimeSeriesReplacementsDataSource"}, + "Tags":{"shape":"Tags"} + } + }, + "CreateWhatIfForecastResponse":{ + "type":"structure", + "members":{ + "WhatIfForecastArn":{"shape":"LongArn"} + } + }, "DataConfig":{ "type":"structure", "required":["DatasetGroupArn"], @@ -1286,6 +1547,27 @@ "ResourceArn":{"shape":"Arn"} } }, + "DeleteWhatIfAnalysisRequest":{ + "type":"structure", + "required":["WhatIfAnalysisArn"], + "members":{ + "WhatIfAnalysisArn":{"shape":"Arn"} + } + }, + "DeleteWhatIfForecastExportRequest":{ + "type":"structure", + "required":["WhatIfForecastExportArn"], + "members":{ + "WhatIfForecastExportArn":{"shape":"LongArn"} + } + }, + "DeleteWhatIfForecastRequest":{ + "type":"structure", + "required":["WhatIfForecastArn"], + "members":{ + "WhatIfForecastArn":{"shape":"LongArn"} + } + }, "DescribeAutoPredictorRequest":{ "type":"structure", "required":["PredictorArn"], @@ -1557,6 +1839,72 @@ "OptimizationMetric":{"shape":"OptimizationMetric"} } }, + "DescribeWhatIfAnalysisRequest":{ + "type":"structure", + "required":["WhatIfAnalysisArn"], + "members":{ + "WhatIfAnalysisArn":{"shape":"Arn"} + } + }, + "DescribeWhatIfAnalysisResponse":{ + "type":"structure", + "members":{ + "WhatIfAnalysisName":{"shape":"Name"}, + "WhatIfAnalysisArn":{"shape":"Arn"}, + "ForecastArn":{"shape":"Arn"}, + "EstimatedTimeRemainingInMinutes":{"shape":"Long"}, + "Status":{"shape":"String"}, + "Message":{"shape":"ErrorMessage"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModificationTime":{"shape":"Timestamp"}, + "TimeSeriesSelector":{"shape":"TimeSeriesSelector"} + } + }, + "DescribeWhatIfForecastExportRequest":{ + "type":"structure", + "required":["WhatIfForecastExportArn"], + "members":{ + "WhatIfForecastExportArn":{"shape":"LongArn"} + } + }, + "DescribeWhatIfForecastExportResponse":{ + "type":"structure", + "members":{ + "WhatIfForecastExportArn":{"shape":"LongArn"}, + "WhatIfForecastExportName":{"shape":"Name"}, + "WhatIfForecastArns":{"shape":"LongArnList"}, + "Destination":{"shape":"DataDestination"}, + "Message":{"shape":"Message"}, + "Status":{"shape":"Status"}, + "CreationTime":{"shape":"Timestamp"}, + "EstimatedTimeRemainingInMinutes":{"shape":"Long"}, + "LastModificationTime":{"shape":"Timestamp"}, + "Format":{"shape":"Format"} + } + }, + "DescribeWhatIfForecastRequest":{ + "type":"structure", + "required":["WhatIfForecastArn"], + "members":{ + "WhatIfForecastArn":{"shape":"LongArn"} + } + }, + "DescribeWhatIfForecastResponse":{ + "type":"structure", + "members":{ + "WhatIfForecastName":{"shape":"Name"}, + "WhatIfForecastArn":{"shape":"LongArn"}, + "WhatIfAnalysisArn":{"shape":"Arn"}, + "EstimatedTimeRemainingInMinutes":{"shape":"Long"}, + "Status":{"shape":"String"}, + "Message":{"shape":"ErrorMessage"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModificationTime":{"shape":"Timestamp"}, + "TimeSeriesTransformations":{"shape":"TimeSeriesTransformations"}, + "TimeSeriesReplacementsDataSource":{"shape":"TimeSeriesReplacementsDataSource"}, + "ForecastTypes":{"shape":"ForecastTypes"} + } + }, "Detail":{ "type":"string", "max":256 @@ -2081,12 +2429,66 @@ "Tags":{"shape":"Tags"} } }, + "ListWhatIfAnalysesRequest":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"}, + "Filters":{"shape":"Filters"} + } + }, + "ListWhatIfAnalysesResponse":{ + "type":"structure", + "members":{ + "WhatIfAnalyses":{"shape":"WhatIfAnalyses"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListWhatIfForecastExportsRequest":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"}, + "Filters":{"shape":"Filters"} + } + }, + "ListWhatIfForecastExportsResponse":{ + "type":"structure", + "members":{ + "WhatIfForecastExports":{"shape":"WhatIfForecastExports"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListWhatIfForecastsRequest":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"NextToken"}, + "MaxResults":{"shape":"MaxResults"}, + "Filters":{"shape":"Filters"} + } + }, + "ListWhatIfForecastsResponse":{ + "type":"structure", + "members":{ + "WhatIfForecasts":{"shape":"WhatIfForecasts"}, + "NextToken":{"shape":"NextToken"} + } + }, "LocalDateTime":{ "type":"string", "max":19, "pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$" }, "Long":{"type":"long"}, + "LongArn":{ + "type":"string", + "max":300, + "pattern":"arn:([a-z\\d-]+):forecast:.*:.*:.+" + }, + "LongArnList":{ + "type":"list", + "member":{"shape":"LongArn"} + }, "MaxResults":{ "type":"integer", "max":100, @@ -2187,6 +2589,15 @@ "min":1, "pattern":".+" }, + "Operation":{ + "type":"string", + "enum":[ + "ADD", + "SUBTRACT", + "MULTIPLY", + "DIVIDE" + ] + }, "OptimizationMetric":{ "type":"string", "enum":[ @@ -2529,6 +2940,25 @@ "SPECIFIC" ] }, + "TimeSeriesCondition":{ + "type":"structure", + "required":[ + "AttributeName", + "AttributeValue", + "Condition" + ], + "members":{ + "AttributeName":{"shape":"Name"}, + "AttributeValue":{"shape":"AttributeValue"}, + "Condition":{"shape":"Condition"} + } + }, + "TimeSeriesConditions":{ + "type":"list", + "member":{"shape":"TimeSeriesCondition"}, + "max":10, + "min":0 + }, "TimeSeriesGranularity":{ "type":"string", "enum":[ @@ -2544,12 +2974,38 @@ "Format":{"shape":"Format"} } }, + "TimeSeriesReplacementsDataSource":{ + "type":"structure", + "required":[ + "S3Config", + "Schema" + ], + "members":{ + "S3Config":{"shape":"S3Config"}, + "Schema":{"shape":"Schema"}, + "Format":{"shape":"Format"}, + "TimestampFormat":{"shape":"TimestampFormat"} + } + }, "TimeSeriesSelector":{ "type":"structure", "members":{ "TimeSeriesIdentifiers":{"shape":"TimeSeriesIdentifiers"} } }, + "TimeSeriesTransformation":{ + "type":"structure", + "members":{ + "Action":{"shape":"Action"}, + "TimeSeriesConditions":{"shape":"TimeSeriesConditions"} + } + }, + "TimeSeriesTransformations":{ + "type":"list", + "member":{"shape":"TimeSeriesTransformation"}, + "max":30, + "min":0 + }, "TimeZone":{ "type":"string", "max":256, @@ -2630,6 +3086,61 @@ "type":"list", "member":{"shape":"WeightedQuantileLoss"} }, + "WhatIfAnalyses":{ + "type":"list", + "member":{"shape":"WhatIfAnalysisSummary"} + }, + "WhatIfAnalysisSummary":{ + "type":"structure", + "members":{ + "WhatIfAnalysisArn":{"shape":"Arn"}, + "WhatIfAnalysisName":{"shape":"Name"}, + "ForecastArn":{"shape":"Arn"}, + "Status":{"shape":"Status"}, + "Message":{"shape":"ErrorMessage"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModificationTime":{"shape":"Timestamp"} + } + }, + "WhatIfForecastArnListForExport":{ + "type":"list", + "member":{"shape":"LongArn"}, + "max":50, + "min":1 + }, + "WhatIfForecastExportSummary":{ + "type":"structure", + "members":{ + "WhatIfForecastExportArn":{"shape":"LongArn"}, + "WhatIfForecastArns":{"shape":"WhatIfForecastArnListForExport"}, + "WhatIfForecastExportName":{"shape":"Name"}, + "Destination":{"shape":"DataDestination"}, + "Status":{"shape":"Status"}, + "Message":{"shape":"ErrorMessage"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModificationTime":{"shape":"Timestamp"} + } + }, + "WhatIfForecastExports":{ + "type":"list", + "member":{"shape":"WhatIfForecastExportSummary"} + }, + "WhatIfForecastSummary":{ + "type":"structure", + "members":{ + "WhatIfForecastArn":{"shape":"LongArn"}, + "WhatIfForecastName":{"shape":"Name"}, + "WhatIfAnalysisArn":{"shape":"Arn"}, + "Status":{"shape":"Status"}, + "Message":{"shape":"ErrorMessage"}, + "CreationTime":{"shape":"Timestamp"}, + "LastModificationTime":{"shape":"Timestamp"} + } + }, + "WhatIfForecasts":{ + "type":"list", + "member":{"shape":"WhatIfForecastSummary"} + }, "WindowSummary":{ "type":"structure", "members":{ diff --git a/models/apis/forecast/2018-06-26/docs-2.json b/models/apis/forecast/2018-06-26/docs-2.json index 51cb4b1a11..62e3bb356d 100644 --- a/models/apis/forecast/2018-06-26/docs-2.json +++ b/models/apis/forecast/2018-06-26/docs-2.json @@ -13,6 +13,9 @@ "CreateMonitor": "

Creates a predictor monitor resource for an existing auto predictor. Predictor monitoring allows you to see how your predictor's performance changes over time. For more information, see Predictor Monitoring.

", "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 CreateAutoPredictor or CreatePredictor operations. Two folders containing CSV or Parquet 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.

", + "CreateWhatIfAnalysis": "

What-if analysis is a scenario modeling technique where you make a hypothetical change to a time series and compare the forecasts generated by these changes against the baseline, unchanged time series. It is important to remember that the purpose of a what-if analysis is to understand how a forecast can change given different modifications to the baseline time series.

For example, imagine you are a clothing retailer who is considering an end of season sale to clear space for new styles. After creating a baseline forecast, you can use a what-if analysis to investigate how different sales tactics might affect your goals. You could create a scenario where everything is given a 25% markdown and another where everything is given a fixed dollar markdown. You can create a scenario where the sale lasts for 1 week and another where the sale lasts for 1 month. Your what-if analysis enables you to compare many different scenarios against each other.

Note that a what-if analysis is meant to display what the forecasting model has learned and how it will behave in the scenarios that you are evaluating. Do not blindly use the results of the what-if analysis to make business decisions. For instance, forecasts might not be accurate for novel scenarios where there is no reference available to determine whether a forecast is good.

The TimeSeriesSelector object defines the items that you want in the what-if analysis.

", + "CreateWhatIfForecast": "

A what-if forecast is a forecast that is created from a modified version of the baseline forecast. Each what-if forecast incorporates either a replacement dataset or a set of transformations to the original dataset.

", + "CreateWhatIfForecastExport": "

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

≈<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>

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 what-if forecast export jobs, use the ListWhatIfForecastExports 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 DescribeWhatIfForecastExport 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 UpdateDatasetGroup 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.

", @@ -24,6 +27,9 @@ "DeletePredictor": "

Deletes a predictor created using the DescribePredictor or CreatePredictor operations. 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.

", + "DeleteWhatIfAnalysis": "

Deletes a what-if analysis created using the CreateWhatIfAnalysis operation. You can delete only what-if analyses that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfAnalysis operation.

You can't delete a what-if analysis while any of its forecasts are being exported.

", + "DeleteWhatIfForecast": "

Deletes a what-if forecast created using the CreateWhatIfForecast operation. You can delete only what-if forecasts that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfForecast operation.

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

", + "DeleteWhatIfForecastExport": "

Deletes a what-if forecast export created using the CreateWhatIfForecastExport operation. You can delete only what-if forecast exports that have a status of ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfForecastExport operation.

", "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:

", @@ -35,6 +41,9 @@ "DescribeMonitor": "

Describes a monitor resource. In addition to listing the properties provided in the CreateMonitor 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.

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:

", + "DescribeWhatIfAnalysis": "

Describes the what-if analysis created using the CreateWhatIfAnalysis operation.

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

", + "DescribeWhatIfForecast": "

Describes the what-if forecast created using the CreateWhatIfForecast operation.

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

", + "DescribeWhatIfForecastExport": "

Describes the what-if forecast export created using the CreateWhatIfForecastExport operation.

In addition to listing the properties provided in the CreateWhatIfForecastExport 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.

", @@ -48,6 +57,9 @@ "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.

", "ListPredictors": "

Returns a list of predictors created using the CreateAutoPredictor or CreatePredictor operations. For each predictor, 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 DescribeAutoPredictor and DescribePredictor operations. You can filter the list using an array of Filter objects.

", "ListTagsForResource": "

Lists the tags for an Amazon Forecast resource.

", + "ListWhatIfAnalyses": "

Returns a list of what-if analyses created using the CreateWhatIfAnalysis operation. For each what-if analysis, 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 what-if analysis ARN with the DescribeWhatIfAnalysis operation.

", + "ListWhatIfForecastExports": "

Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport operation. For each what-if forecast export, 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 what-if forecast export ARN with the DescribeWhatIfForecastExport operation.

", + "ListWhatIfForecasts": "

Returns a list of what-if forecasts created using the CreateWhatIfForecast operation. For each what-if forecast, 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 what-if forecast ARN with the DescribeWhatIfForecast operation.

", "ResumeResource": "

Resumes a stopped monitor resource.

", "StopResource": "

Stops a resource.

The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED. You cannot resume a resource once it has been stopped.

This operation can be applied to the following resources (and their corresponding child resources):

", "TagResource": "

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

", @@ -55,6 +67,12 @@ "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": { + "Action": { + "base": "

Defines the modifications that you are making to an attribute for a what-if forecast. For example, you can use this operation to create a what-if forecast that investigates a 10% off sale on all shoes. To do this, you specify \"AttributeName\": \"shoes\", \"Operation\": \"MULTIPLY\", and \"Value\": \"0.90\". Pair this operation with the TimeSeriesCondition operation within the CreateWhatIfForecastRequest$TimeSeriesTransformations operation to define a subset of attribute items that are modified.

", + "refs": { + "TimeSeriesTransformation$Action": "

An array of actions that define a time series and how it is transformed. These transformations create a new time series that is used for the what-if analysis.

" + } + }, "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": { @@ -91,6 +109,9 @@ "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.

", + "CreateWhatIfAnalysisRequest$ForecastArn": "

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

", + "CreateWhatIfAnalysisResponse$WhatIfAnalysisArn": "

The Amazon Resource Name (ARN) of the what-if analysis.

", + "CreateWhatIfForecastRequest$WhatIfAnalysisArn": "

The Amazon Resource Name (ARN) of the what-if analysis.

", "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.

", @@ -106,6 +127,7 @@ "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.

", + "DeleteWhatIfAnalysisRequest$WhatIfAnalysisArn": "

The Amazon Resource Name (ARN) of the what-if analysis that you want to delete.

", "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.

", @@ -136,6 +158,10 @@ "DescribePredictorBacktestExportJobResponse$PredictorArn": "

The Amazon Resource Name (ARN) of the predictor.

", "DescribePredictorRequest$PredictorArn": "

The Amazon Resource Name (ARN) of the predictor that you want information about.

", "DescribePredictorResponse$AlgorithmArn": "

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

", + "DescribeWhatIfAnalysisRequest$WhatIfAnalysisArn": "

The Amazon Resource Name (ARN) of the what-if analysis that you are interested in.

", + "DescribeWhatIfAnalysisResponse$WhatIfAnalysisArn": "

The Amazon Resource Name (ARN) of the what-if analysis.

", + "DescribeWhatIfAnalysisResponse$ForecastArn": "

The Amazon Resource Name (ARN) of the what-if forecast.

", + "DescribeWhatIfForecastResponse$WhatIfAnalysisArn": "

The Amazon Resource Name (ARN) of the what-if analysis that contains this forecast.

", "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.

", @@ -167,7 +193,10 @@ "StopResourceRequest$ResourceArn": "

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

", "TagResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.

", "UntagResourceRequest$ResourceArn": "

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.

", - "UpdateDatasetGroupRequest$DatasetGroupArn": "

The ARN of the dataset group.

" + "UpdateDatasetGroupRequest$DatasetGroupArn": "

The ARN of the dataset group.

", + "WhatIfAnalysisSummary$WhatIfAnalysisArn": "

The Amazon Resource Name (ARN) of the what-if analysis.

", + "WhatIfAnalysisSummary$ForecastArn": "

The Amazon Resource Name (ARN) of the baseline forecast that is being used in this what-if analysis.

", + "WhatIfForecastSummary$WhatIfAnalysisArn": "

The Amazon Resource Name (ARN) of the what-if analysis that contains this what-if forecast.

" } }, "ArnList": { @@ -199,6 +228,12 @@ "SchemaAttribute$AttributeType": "

The data type of the field.

For a related time series dataset, other than date, item_id, and forecast dimensions attributes, all attributes should be of numerical type (integer/float).

" } }, + "AttributeValue": { + "base": null, + "refs": { + "TimeSeriesCondition$AttributeValue": "

The value that is applied for the chosen Condition.

" + } + }, "AutoMLOverrideStrategy": { "base": null, "refs": { @@ -253,6 +288,12 @@ "ParameterRanges$CategoricalParameterRanges": "

Specifies the tunable range for each categorical hyperparameter.

" } }, + "Condition": { + "base": null, + "refs": { + "TimeSeriesCondition$Condition": "

The condition to apply. Valid values are EQUALS, NOT_EQUALS, LESS_THAN and GREATER_THAN.

" + } + }, "Configuration": { "base": null, "refs": { @@ -381,6 +422,36 @@ "refs": { } }, + "CreateWhatIfAnalysisRequest": { + "base": null, + "refs": { + } + }, + "CreateWhatIfAnalysisResponse": { + "base": null, + "refs": { + } + }, + "CreateWhatIfForecastExportRequest": { + "base": null, + "refs": { + } + }, + "CreateWhatIfForecastExportResponse": { + "base": null, + "refs": { + } + }, + "CreateWhatIfForecastRequest": { + "base": null, + "refs": { + } + }, + "CreateWhatIfForecastResponse": { + "base": null, + "refs": { + } + }, "DataConfig": { "base": "

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

", "refs": { @@ -394,12 +465,15 @@ "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, + "CreateWhatIfForecastExportRequest$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.

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

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

", "DescribePredictorBacktestExportJobResponse$Destination": null, + "DescribeWhatIfForecastExportResponse$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 + "PredictorBacktestExportJobSummary$Destination": null, + "WhatIfForecastExportSummary$Destination": "

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

" } }, "DataSource": { @@ -524,6 +598,21 @@ "refs": { } }, + "DeleteWhatIfAnalysisRequest": { + "base": null, + "refs": { + } + }, + "DeleteWhatIfForecastExportRequest": { + "base": null, + "refs": { + } + }, + "DeleteWhatIfForecastRequest": { + "base": null, + "refs": { + } + }, "DescribeAutoPredictorRequest": { "base": null, "refs": { @@ -634,6 +723,36 @@ "refs": { } }, + "DescribeWhatIfAnalysisRequest": { + "base": null, + "refs": { + } + }, + "DescribeWhatIfAnalysisResponse": { + "base": null, + "refs": { + } + }, + "DescribeWhatIfForecastExportRequest": { + "base": null, + "refs": { + } + }, + "DescribeWhatIfForecastExportResponse": { + "base": null, + "refs": { + } + }, + "DescribeWhatIfForecastRequest": { + "base": null, + "refs": { + } + }, + "DescribeWhatIfForecastResponse": { + "base": null, + "refs": { + } + }, "Detail": { "base": null, "refs": { @@ -653,6 +772,7 @@ "Double": { "base": null, "refs": { + "Action$Value": "

The value that is applied for the chosen Operation.

", "BaselineMetric$Value": "

The value for the metric.

", "ContinuousParameterRange$MaxValue": "

The maximum tunable value of the hyperparameter.

", "ContinuousParameterRange$MinValue": "

The minimum tunable value of the hyperparameter.

", @@ -686,6 +806,8 @@ "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.

", + "DescribeWhatIfAnalysisResponse$Message": "

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

", + "DescribeWhatIfForecastResponse$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.

", @@ -697,7 +819,10 @@ "ResourceAlreadyExistsException$Message": null, "ResourceInUseException$Message": null, "ResourceNotFoundException$Message": null, - "TestWindowSummary$Message": "

If the test failed, the reason why it failed.

" + "TestWindowSummary$Message": "

If the test failed, the reason why it failed.

", + "WhatIfAnalysisSummary$Message": "

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

", + "WhatIfForecastExportSummary$Message": "

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

", + "WhatIfForecastSummary$Message": "

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

" } }, "ErrorMetric": { @@ -848,7 +973,10 @@ "ListMonitorEvaluationsRequest$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

For example, to list only successful monitor evaluations, you would specify:

\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"EvaluationState\", \"Value\": \"SUCCESS\" } ]

", "ListMonitorsRequest$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

For example, to list all monitors who's status is ACTIVE, you would specify:

\"Filters\": [ { \"Condition\": \"IS\", \"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

", - "ListPredictorsRequest$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 predictors 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 predictors whose status is ACTIVE, you would specify:

\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" } ]

" + "ListPredictorsRequest$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 predictors 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 predictors whose status is ACTIVE, you would specify:

\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" } ]

", + "ListWhatIfAnalysesRequest$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 what-if analysis 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 electricityWhatIf, specify the following filter:

\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"WhatIfAnalysisArn\", \"Value\": \"arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIf\" } ]

", + "ListWhatIfForecastExportsRequest$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 what-if 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 electricityWIFExport, specify the following filter:

\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"WhatIfForecastExportArn\", \"Value\": \"arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWIFExport\" } ]

", + "ListWhatIfForecastsRequest$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 what-if 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 electricityWhatIfForecast, specify the following filter:

\"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"WhatIfForecastArn\", \"Value\": \"arn:aws:forecast:us-west-2:<acct-id>:forecast/electricityWhatIfForecast\" } ]

" } }, "ForecastDimensions": { @@ -892,7 +1020,8 @@ "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\"]

" + "DescribePredictorResponse$ForecastTypes": "

The forecast types used during predictor training. Default value is [\"0.1\",\"0.5\",\"0.9\"]

", + "DescribeWhatIfForecastResponse$ForecastTypes": "

The quantiles at which probabilistic forecasts are generated. You can specify up to 5 quantiles per what-if forecast in the CreateWhatIfForecast operation. If you didn't specify quantiles, the default values are [\"0.1\", \"0.5\", \"0.9\"].

" } }, "Forecasts": { @@ -908,11 +1037,14 @@ "CreateExplainabilityExportRequest$Format": "

The format of the exported data, CSV or PARQUET.

", "CreateForecastExportJobRequest$Format": "

The format of the exported data, CSV or PARQUET. The default value is CSV.

", "CreatePredictorBacktestExportJobRequest$Format": "

The format of the exported data, CSV or PARQUET. The default value is CSV.

", + "CreateWhatIfForecastExportRequest$Format": "

The format of the exported data, CSV or PARQUET.

", "DescribeDatasetImportJobResponse$Format": "

The format of the imported data, CSV or PARQUET.

", "DescribeExplainabilityExportResponse$Format": "

The format of the exported data, CSV or PARQUET.

", "DescribeForecastExportJobResponse$Format": "

The format of the exported data, CSV or PARQUET.

", "DescribePredictorBacktestExportJobResponse$Format": "

The format of the exported data, CSV or PARQUET.

", - "TimeSeriesIdentifiers$Format": "

The format of the data, either CSV or PARQUET.

" + "DescribeWhatIfForecastExportResponse$Format": "

The format of the exported data, CSV or PARQUET.

", + "TimeSeriesIdentifiers$Format": "

The format of the data, either CSV or PARQUET.

", + "TimeSeriesReplacementsDataSource$Format": "

The format of the replacement data, CSV or PARQUET.

" } }, "Frequency": { @@ -1134,6 +1266,36 @@ "refs": { } }, + "ListWhatIfAnalysesRequest": { + "base": null, + "refs": { + } + }, + "ListWhatIfAnalysesResponse": { + "base": null, + "refs": { + } + }, + "ListWhatIfForecastExportsRequest": { + "base": null, + "refs": { + } + }, + "ListWhatIfForecastExportsResponse": { + "base": null, + "refs": { + } + }, + "ListWhatIfForecastsRequest": { + "base": null, + "refs": { + } + }, + "ListWhatIfForecastsResponse": { + "base": null, + "refs": { + } + }, "LocalDateTime": { "base": null, "refs": { @@ -1152,6 +1314,9 @@ "DescribeForecastResponse$EstimatedTimeRemainingInMinutes": "

The estimated time remaining in minutes for the forecast job to complete.

", "DescribeMonitorResponse$EstimatedEvaluationTimeRemainingInMinutes": "

The estimated number of minutes remaining before the monitor resource finishes its current evaluation.

", "DescribePredictorResponse$EstimatedTimeRemainingInMinutes": "

The estimated time remaining in minutes for the predictor training job to complete.

", + "DescribeWhatIfAnalysisResponse$EstimatedTimeRemainingInMinutes": "

The approximate time remaining to complete the what-if analysis, in minutes.

", + "DescribeWhatIfForecastExportResponse$EstimatedTimeRemainingInMinutes": "

The approximate time remaining to complete the what-if forecast export, in minutes.

", + "DescribeWhatIfForecastResponse$EstimatedTimeRemainingInMinutes": "

The approximate time remaining to complete the what-if forecast, in minutes.

", "PredictorMonitorEvaluation$NumItemsEvaluated": "

The number of items considered during the evaluation.

", "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.

", "Statistics$CountDistinctLong": "

The number of distinct values in the field. CountDistinctLong is used instead of CountDistinct if the value is greater than 2,147,483,647.

", @@ -1159,6 +1324,29 @@ "Statistics$CountNanLong": "

The number of NAN (not a number) values in the field. CountNanLong is used instead of CountNan if the value is greater than 2,147,483,647.

" } }, + "LongArn": { + "base": null, + "refs": { + "CreateWhatIfForecastExportResponse$WhatIfForecastExportArn": "

The Amazon Resource Name (ARN) of the what-if forecast.

", + "CreateWhatIfForecastResponse$WhatIfForecastArn": "

The Amazon Resource Name (ARN) of the what-if forecast.

", + "DeleteWhatIfForecastExportRequest$WhatIfForecastExportArn": "

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

", + "DeleteWhatIfForecastRequest$WhatIfForecastArn": "

The Amazon Resource Name (ARN) of the what-if forecast that you want to delete.

", + "DescribeWhatIfForecastExportRequest$WhatIfForecastExportArn": "

The Amazon Resource Name (ARN) of the what-if forecast export that you are interested in.

", + "DescribeWhatIfForecastExportResponse$WhatIfForecastExportArn": "

The Amazon Resource Name (ARN) of the what-if forecast export.

", + "DescribeWhatIfForecastRequest$WhatIfForecastArn": "

The Amazon Resource Name (ARN) of the what-if forecast that you are interested in.

", + "DescribeWhatIfForecastResponse$WhatIfForecastArn": "

The Amazon Resource Name (ARN) of the what-if forecast.

", + "LongArnList$member": null, + "WhatIfForecastArnListForExport$member": null, + "WhatIfForecastExportSummary$WhatIfForecastExportArn": "

The Amazon Resource Name (ARN) of the what-if forecast export.

", + "WhatIfForecastSummary$WhatIfForecastArn": "

The Amazon Resource Name (ARN) of the what-if forecast.

" + } + }, + "LongArnList": { + "base": null, + "refs": { + "DescribeWhatIfForecastExportResponse$WhatIfForecastArns": "

An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.

" + } + }, "MaxResults": { "base": null, "refs": { @@ -1172,7 +1360,10 @@ "ListMonitorEvaluationsRequest$MaxResults": "

The maximum number of monitoring results to return.

", "ListMonitorsRequest$MaxResults": "

The maximum number of monitors to include in the response.

", "ListPredictorBacktestExportJobsRequest$MaxResults": "

The number of items to return in the response.

", - "ListPredictorsRequest$MaxResults": "

The number of items to return in the response.

" + "ListPredictorsRequest$MaxResults": "

The number of items to return in the response.

", + "ListWhatIfAnalysesRequest$MaxResults": "

The number of items to return in the response.

", + "ListWhatIfForecastExportsRequest$MaxResults": "

The number of items to return in the response.

", + "ListWhatIfForecastsRequest$MaxResults": "

The number of items to return in the response.

" } }, "Message": { @@ -1186,6 +1377,7 @@ "DescribeMonitorResponse$Message": "

An error message, if any, for the monitor.

", "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.

", + "DescribeWhatIfForecastExportResponse$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.

", "PredictorMonitorEvaluation$Message": "

Information about any errors that may have occurred during the monitor evaluation.

" } @@ -1253,6 +1445,7 @@ "Name": { "base": null, "refs": { + "Action$AttributeName": "

The related time series that you are modifying. This value is case insensitive.

", "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.

", "BaselineMetric$Name": "

The name of the metric.

", @@ -1270,6 +1463,9 @@ "CreateMonitorRequest$MonitorName": "

The name of the monitor resource.

", "CreatePredictorBacktestExportJobRequest$PredictorBacktestExportJobName": "

The name for the backtest export job.

", "CreatePredictorRequest$PredictorName": "

A name for the predictor.

", + "CreateWhatIfAnalysisRequest$WhatIfAnalysisName": "

The name of the what-if analysis. Each name must be unique.

", + "CreateWhatIfForecastExportRequest$WhatIfForecastExportName": "

The name of the what-if forecast to export.

", + "CreateWhatIfForecastRequest$WhatIfForecastName": "

The name of the what-if forecast. Names must be unique within each what-if analysis.

", "DatasetGroupSummary$DatasetGroupName": "

The name of the dataset group.

", "DatasetImportJobSummary$DatasetImportJobName": "

The name of the dataset import job.

", "DatasetSummary$DatasetName": "

The name of the dataset.

", @@ -1285,6 +1481,9 @@ "DescribePredictorBacktestExportJobResponse$PredictorBacktestExportJobName": "

The name of the predictor backtest export job.

", "DescribePredictorResponse$PredictorArn": "

The ARN of the predictor.

", "DescribePredictorResponse$PredictorName": "

The name of the predictor.

", + "DescribeWhatIfAnalysisResponse$WhatIfAnalysisName": "

The name of the what-if analysis.

", + "DescribeWhatIfForecastExportResponse$WhatIfForecastExportName": "

The name of the what-if forecast export.

", + "DescribeWhatIfForecastResponse$WhatIfForecastName": "

The name of the what-if forecast.

", "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.

", @@ -1298,7 +1497,11 @@ "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\".

", - "Transformations$key": null + "TimeSeriesCondition$AttributeName": "

The item_id, dimension name, IM name, or timestamp that you are modifying.

", + "Transformations$key": null, + "WhatIfAnalysisSummary$WhatIfAnalysisName": "

The name of the what-if analysis.

", + "WhatIfForecastExportSummary$WhatIfForecastExportName": "

The what-if forecast export name.

", + "WhatIfForecastSummary$WhatIfForecastName": "

The name of the what-if forecast.

" } }, "NextToken": { @@ -1325,7 +1528,19 @@ "ListPredictorBacktestExportJobsRequest$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.

", "ListPredictorBacktestExportJobsResponse$NextToken": "

Returns this token if the response is truncated. To retrieve the next set of results, use the token in the next request.

", "ListPredictorsRequest$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.

", - "ListPredictorsResponse$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.

" + "ListPredictorsResponse$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.

", + "ListWhatIfAnalysesRequest$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.

", + "ListWhatIfAnalysesResponse$NextToken": "

If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request.

", + "ListWhatIfForecastExportsRequest$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.

", + "ListWhatIfForecastExportsResponse$NextToken": "

If the response is truncated, Forecast returns this token. To retrieve the next set of results, use the token in the next request.

", + "ListWhatIfForecastsRequest$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.

", + "ListWhatIfForecastsResponse$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.

" + } + }, + "Operation": { + "base": null, + "refs": { + "Action$Operation": "

The operation that is applied to the provided attribute. Operations include:

" } }, "OptimizationMetric": { @@ -1461,7 +1676,8 @@ "base": "

The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the file(s). Optionally, includes an AWS Key Management Service (KMS) key. This object is part of the DataSource object that is submitted in the CreateDatasetImportJob request, and part of the DataDestination object.

", "refs": { "DataDestination$S3Config": "

The path to an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the bucket.

", - "DataSource$S3Config": "

The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.

" + "DataSource$S3Config": "

The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the credentials to access the data.

", + "TimeSeriesReplacementsDataSource$S3Config": null } }, "S3Path": { @@ -1484,7 +1700,8 @@ "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, - "TimeSeriesIdentifiers$Schema": null + "TimeSeriesIdentifiers$Schema": null, + "TimeSeriesReplacementsDataSource$Schema": null } }, "SchemaAttribute": { @@ -1525,6 +1742,7 @@ "DescribeMonitorResponse$Status": "

The status of the monitor resource.

", "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.

", + "DescribeWhatIfForecastExportResponse$Status": "

The status of the what-if forecast. States include:

The Status of the what-if forecast export must be ACTIVE before you can access the forecast export.

", "ExplainabilityExportSummary$Status": "

The status of the Explainability export. States include:

", "ExplainabilityInfo$Status": "

The status of the Explainability. States include:

", "ExplainabilitySummary$Status": "

The status of the Explainability. States include:

", @@ -1534,7 +1752,10 @@ "MonitorSummary$Status": "

The status of the monitor. States include:

", "PredictorBacktestExportJobSummary$Status": "

The status of the predictor backtest export job. States include:

", "PredictorSummary$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.

", - "TestWindowSummary$Status": "

The status of the test. Possible status values are:

" + "TestWindowSummary$Status": "

The status of the test. Possible status values are:

", + "WhatIfAnalysisSummary$Status": "

The status of the what-if analysis. States include:

The Status of the what-if analysis must be ACTIVE before you can access the analysis.

", + "WhatIfForecastExportSummary$Status": "

The status of the what-if forecast export. States include:

The Status of the what-if analysis must be ACTIVE before you can access the analysis.

", + "WhatIfForecastSummary$Status": "

The status of the what-if forecast. States include:

The Status of the what-if analysis must be ACTIVE before you can access the analysis.

" } }, "StopResourceRequest": { @@ -1546,6 +1767,8 @@ "base": null, "refs": { "DescribeForecastResponse$Status": "

The status of the forecast. States include:

The Status of the forecast must be ACTIVE before you can query or export the forecast.

", + "DescribeWhatIfAnalysisResponse$Status": "

The status of the what-if analysis. States include:

The Status of the what-if analysis must be ACTIVE before you can access the analysis.

", + "DescribeWhatIfForecastResponse$Status": "

The status of the what-if forecast. States include:

The Status of the what-if forecast must be ACTIVE before you can access the forecast.

", "FieldStatistics$key": null, "Filter$Key": "

The name of the parameter to filter on.

", "ForecastSummary$PredictorArn": "

The ARN of the predictor used to generate the forecast.

", @@ -1615,6 +1838,9 @@ "CreateMonitorRequest$Tags": "

A list of tags to apply to the monitor resource.

", "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:

", "CreatePredictorRequest$Tags": "

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:

", + "CreateWhatIfAnalysisRequest$Tags": "

A list of tags to apply to the what if forecast.

", + "CreateWhatIfForecastExportRequest$Tags": "

A list of tags to apply to the what if forecast.

", + "CreateWhatIfForecastRequest$Tags": "

A list of tags to apply to the what if forecast.

", "ListTagsForResourceResponse$Tags": "

The tags for the resource.

", "TagResourceRequest$Tags": "

The tags to add to the resource. A tag is an array of key-value pairs.

The following basic restrictions apply to tags:

" } @@ -1650,6 +1876,18 @@ "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.

" } }, + "TimeSeriesCondition": { + "base": "

Creates a subset of items within an attribute that are modified. For example, you can use this operation to create a subset of items that cost $5 or less. To do this, you specify \"AttributeName\": \"price\", \"AttributeValue\": \"5\", and \"Condition\": \"LESS_THAN\". Pair this operation with the Action operation within the CreateWhatIfForecastRequest$TimeSeriesTransformations operation to define how the attribute is modified.

", + "refs": { + "TimeSeriesConditions$member": null + } + }, + "TimeSeriesConditions": { + "base": null, + "refs": { + "TimeSeriesTransformation$TimeSeriesConditions": "

An array of conditions that define which members of the related time series are transformed.

" + } + }, "TimeSeriesGranularity": { "base": null, "refs": { @@ -1662,11 +1900,33 @@ "TimeSeriesSelector$TimeSeriesIdentifiers": "

Details about the import file that contains the time series for which you want to create forecasts.

" } }, + "TimeSeriesReplacementsDataSource": { + "base": "

A replacement dataset is a modified version of the baseline related time series that contains only the values that you want to include in a what-if forecast. The replacement dataset must contain the forecast dimensions and item identifiers in the baseline related time series as well as at least 1 changed time series. This dataset is merged with the baseline related time series to create a transformed dataset that is used for the what-if forecast.

", + "refs": { + "CreateWhatIfForecastRequest$TimeSeriesReplacementsDataSource": "

The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast. This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.

This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.

Timestamps and item_ids not included in this dataset are not included in the what-if analysis.

", + "DescribeWhatIfForecastResponse$TimeSeriesReplacementsDataSource": "

An array of S3Config, Schema, and Format elements that describe the replacement time series.

" + } + }, "TimeSeriesSelector": { "base": "

Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers object.

The TimeSeriesIdentifiers object needs the following information:

", "refs": { "CreateForecastRequest$TimeSeriesSelector": "

Defines the set of time series that are used to create the forecasts in a TimeSeriesIdentifiers object.

The TimeSeriesIdentifiers object needs the following information:

", - "DescribeForecastResponse$TimeSeriesSelector": "

The time series to include in the forecast.

" + "CreateWhatIfAnalysisRequest$TimeSeriesSelector": "

Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.

The TimeSeriesIdentifiers object needs the following information:

", + "DescribeForecastResponse$TimeSeriesSelector": "

The time series to include in the forecast.

", + "DescribeWhatIfAnalysisResponse$TimeSeriesSelector": null + } + }, + "TimeSeriesTransformation": { + "base": "

A transformation function is a pair of operations that select and modify the rows in a related time series. You select the rows that you want with a condition operation and you modify the rows with a transformation operation. All conditions are joined with an AND operation, meaning that all conditions must be true for the transformation to be applied. Transformations are applied in the order that they are listed.

", + "refs": { + "TimeSeriesTransformations$member": null + } + }, + "TimeSeriesTransformations": { + "base": null, + "refs": { + "CreateWhatIfForecastRequest$TimeSeriesTransformations": "

The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.

", + "DescribeWhatIfForecastResponse$TimeSeriesTransformations": "

An array of Action and TimeSeriesConditions elements that describe what transformations were applied to which time series.

" } }, "TimeZone": { @@ -1708,6 +1968,12 @@ "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:

", + "DescribeWhatIfAnalysisResponse$CreationTime": "

When the what-if analysis was created.

", + "DescribeWhatIfAnalysisResponse$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", + "DescribeWhatIfForecastExportResponse$CreationTime": "

When the what-if forecast export was created.

", + "DescribeWhatIfForecastExportResponse$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", + "DescribeWhatIfForecastResponse$CreationTime": "

When the what-if forecast was created.

", + "DescribeWhatIfForecastResponse$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.

", @@ -1728,6 +1994,12 @@ "PredictorSummary$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", "TestWindowSummary$TestWindowStart": "

The time at which the test began.

", "TestWindowSummary$TestWindowEnd": "

The time at which the test ended.

", + "WhatIfAnalysisSummary$CreationTime": "

When the what-if analysis was created.

", + "WhatIfAnalysisSummary$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", + "WhatIfForecastExportSummary$CreationTime": "

When the what-if forecast export was created.

", + "WhatIfForecastExportSummary$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", + "WhatIfForecastSummary$CreationTime": "

When the what-if forecast was created.

", + "WhatIfForecastSummary$LastModificationTime": "

The last time the resource was modified. The timestamp depends on the status of the job:

", "WindowSummary$TestWindowStart": "

The timestamp that defines the start of the window.

", "WindowSummary$TestWindowEnd": "

The timestamp that defines the end of the window.

" } @@ -1736,7 +2008,8 @@ "base": null, "refs": { "CreateDatasetImportJobRequest$TimestampFormat": "

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

If the format isn't specified, Amazon Forecast expects the format to be \"yyyy-MM-dd HH:mm:ss\".

", - "DescribeDatasetImportJobResponse$TimestampFormat": "

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

" + "DescribeDatasetImportJobResponse$TimestampFormat": "

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

", + "TimeSeriesReplacementsDataSource$TimestampFormat": "

The timestamp format of the replacement data.

" } }, "TrainingParameters": { @@ -1806,6 +2079,49 @@ "Metrics$WeightedQuantileLosses": "

An array of weighted quantile losses. Quantiles divide a probability distribution into regions of equal probability. The distribution in this case is the loss function.

" } }, + "WhatIfAnalyses": { + "base": null, + "refs": { + "ListWhatIfAnalysesResponse$WhatIfAnalyses": "

An array of WhatIfAnalysisSummary objects that describe the matched analyses.

" + } + }, + "WhatIfAnalysisSummary": { + "base": "

Provides a summary of the what-if analysis properties used in the ListWhatIfAnalyses operation. To get the complete set of properties, call the DescribeWhatIfAnalysis operation, and provide the WhatIfAnalysisArn that is listed in the summary.

", + "refs": { + "WhatIfAnalyses$member": null + } + }, + "WhatIfForecastArnListForExport": { + "base": null, + "refs": { + "CreateWhatIfForecastExportRequest$WhatIfForecastArns": "

The list of what-if forecast Amazon Resource Names (ARNs) to export.

", + "WhatIfForecastExportSummary$WhatIfForecastArns": "

An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.

" + } + }, + "WhatIfForecastExportSummary": { + "base": "

Provides a summary of the what-if forecast export properties used in the ListWhatIfForecastExports operation. To get the complete set of properties, call the DescribeWhatIfForecastExport operation, and provide the WhatIfForecastExportArn that is listed in the summary.

", + "refs": { + "WhatIfForecastExports$member": null + } + }, + "WhatIfForecastExports": { + "base": null, + "refs": { + "ListWhatIfForecastExportsResponse$WhatIfForecastExports": "

An array of WhatIfForecastExports objects that describe the matched forecast exports.

" + } + }, + "WhatIfForecastSummary": { + "base": "

Provides a summary of the what-if forecast properties used in the ListWhatIfForecasts operation. To get the complete set of properties, call the DescribeWhatIfForecast operation, and provide the WhatIfForecastArn that is listed in the summary.

", + "refs": { + "WhatIfForecasts$member": null + } + }, + "WhatIfForecasts": { + "base": null, + "refs": { + "ListWhatIfForecastsResponse$WhatIfForecasts": "

An array of WhatIfForecasts objects that describe the matched forecasts.

" + } + }, "WindowSummary": { "base": "

The metrics for a time range within the evaluation portion of a dataset. This object is part of the EvaluationResult object.

The TestWindowStart and TestWindowEnd parameters are determined by the BackTestWindowOffset parameter of the EvaluationParameters object.

", "refs": { diff --git a/models/apis/forecast/2018-06-26/paginators-1.json b/models/apis/forecast/2018-06-26/paginators-1.json index 6543bf3f27..f058af9571 100644 --- a/models/apis/forecast/2018-06-26/paginators-1.json +++ b/models/apis/forecast/2018-06-26/paginators-1.json @@ -65,6 +65,24 @@ "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "Predictors" + }, + "ListWhatIfAnalyses": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "WhatIfAnalyses" + }, + "ListWhatIfForecastExports": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "WhatIfForecastExports" + }, + "ListWhatIfForecasts": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "WhatIfForecasts" } } } \ No newline at end of file diff --git a/models/apis/forecastquery/2018-06-26/api-2.json b/models/apis/forecastquery/2018-06-26/api-2.json index b9fd5901c7..17c10c2055 100644 --- a/models/apis/forecastquery/2018-06-26/api-2.json +++ b/models/apis/forecastquery/2018-06-26/api-2.json @@ -28,6 +28,22 @@ {"shape":"LimitExceededException"}, {"shape":"InvalidNextTokenException"} ] + }, + "QueryWhatIfForecast":{ + "name":"QueryWhatIfForecast", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"QueryWhatIfForecastRequest"}, + "output":{"shape":"QueryWhatIfForecastResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceInUseException"}, + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidNextTokenException"} + ] } }, "shapes":{ @@ -89,6 +105,11 @@ }, "exception":true }, + "LongArn":{ + "type":"string", + "max":300, + "pattern":"arn:([a-z\\d-]+):forecast:.*:.*:.+" + }, "NextToken":{ "type":"string", "max":3000, @@ -119,6 +140,26 @@ "Forecast":{"shape":"Forecast"} } }, + "QueryWhatIfForecastRequest":{ + "type":"structure", + "required":[ + "WhatIfForecastArn", + "Filters" + ], + "members":{ + "WhatIfForecastArn":{"shape":"LongArn"}, + "StartDate":{"shape":"DateTime"}, + "EndDate":{"shape":"DateTime"}, + "Filters":{"shape":"Filters"}, + "NextToken":{"shape":"NextToken"} + } + }, + "QueryWhatIfForecastResponse":{ + "type":"structure", + "members":{ + "Forecast":{"shape":"Forecast"} + } + }, "ResourceInUseException":{ "type":"structure", "members":{ diff --git a/models/apis/forecastquery/2018-06-26/docs-2.json b/models/apis/forecastquery/2018-06-26/docs-2.json index 39afc213eb..5b474092b4 100644 --- a/models/apis/forecastquery/2018-06-26/docs-2.json +++ b/models/apis/forecastquery/2018-06-26/docs-2.json @@ -2,7 +2,8 @@ "version": "2.0", "service": "

Provides APIs for creating and managing Amazon Forecast resources.

", "operations": { - "QueryForecast": "

Retrieves a forecast for a single item, filtered by the supplied criteria.

The criteria is a key-value pair. The key is either item_id (or the equivalent non-timestamp, non-target field) from the TARGET_TIME_SERIES dataset, or one of the forecast dimensions specified as part of the FeaturizationConfig object.

By default, QueryForecast returns the complete date range for the filtered forecast. You can request a specific date range.

To get the full forecast, use the CreateForecastExportJob operation.

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

" + "QueryForecast": "

Retrieves a forecast for a single item, filtered by the supplied criteria.

The criteria is a key-value pair. The key is either item_id (or the equivalent non-timestamp, non-target field) from the TARGET_TIME_SERIES dataset, or one of the forecast dimensions specified as part of the FeaturizationConfig object.

By default, QueryForecast returns the complete date range for the filtered forecast. You can request a specific date range.

To get the full forecast, use the CreateForecastExportJob operation.

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

", + "QueryWhatIfForecast": "

Retrieves a what-if forecast.

" }, "shapes": { "Arn": { @@ -33,7 +34,9 @@ "base": null, "refs": { "QueryForecastRequest$StartDate": "

The start date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.

", - "QueryForecastRequest$EndDate": "

The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.

" + "QueryForecastRequest$EndDate": "

The end date for the forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.

", + "QueryWhatIfForecastRequest$StartDate": "

The start date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00.

", + "QueryWhatIfForecastRequest$EndDate": "

The end date for the what-if forecast. Specify the date using this format: yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00.

" } }, "Double": { @@ -55,13 +58,15 @@ "Filters": { "base": null, "refs": { - "QueryForecastRequest$Filters": "

The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for client_21 in the electricity usage dataset, specify the following:

{\"item_id\" : \"client_21\"}

To get the full forecast, use the CreateForecastExportJob operation.

" + "QueryForecastRequest$Filters": "

The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for client_21 in the electricity usage dataset, specify the following:

{\"item_id\" : \"client_21\"}

To get the full forecast, use the CreateForecastExportJob operation.

", + "QueryWhatIfForecastRequest$Filters": "

The filtering criteria to apply when retrieving the forecast. For example, to get the forecast for client_21 in the electricity usage dataset, specify the following:

{\"item_id\" : \"client_21\"}

To get the full what-if forecast, use the CreateForecastExportJob operation.

" } }, "Forecast": { "base": "

Provides information about a forecast. Returned as part of the QueryForecast response.

", "refs": { - "QueryForecastResponse$Forecast": "

The forecast.

" + "QueryForecastResponse$Forecast": "

The forecast.

", + "QueryWhatIfForecastResponse$Forecast": null } }, "InvalidInputException": { @@ -79,16 +84,23 @@ "refs": { } }, + "LongArn": { + "base": null, + "refs": { + "QueryWhatIfForecastRequest$WhatIfForecastArn": "

The Amazon Resource Name (ARN) of the what-if forecast to query.

" + } + }, "NextToken": { "base": null, "refs": { - "QueryForecastRequest$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.

" + "QueryForecastRequest$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.

", + "QueryWhatIfForecastRequest$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.

" } }, "Predictions": { "base": null, "refs": { - "Forecast$Predictions": "

The forecast.

The string of the string-to-array map is one of the following values:

" + "Forecast$Predictions": "

The forecast.

The string of the string-to-array map is one of the following values:

The default setting is [\"0.1\", \"0.5\", \"0.9\"]. Use the optional ForecastTypes parameter of the CreateForecast operation to change the values. The values will vary depending on how this is set, with a minimum of 1 and a maximum of 5.

" } }, "QueryForecastRequest": { @@ -101,6 +113,16 @@ "refs": { } }, + "QueryWhatIfForecastRequest": { + "base": null, + "refs": { + } + }, + "QueryWhatIfForecastResponse": { + "base": null, + "refs": { + } + }, "ResourceInUseException": { "base": "

The specified resource is in use.

", "refs": { diff --git a/models/apis/iotsitewise/2019-12-02/api-2.json b/models/apis/iotsitewise/2019-12-02/api-2.json index 72ecb1779b..c4509b25cf 100644 --- a/models/apis/iotsitewise/2019-12-02/api-2.json +++ b/models/apis/iotsitewise/2019-12-02/api-2.json @@ -21,6 +21,7 @@ "input":{"shape":"AssociateAssetsRequest"}, "errors":[ {"shape":"InvalidRequestException"}, + {"shape":"ResourceAlreadyExistsException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"}, 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 c555538d26..8474374109 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 @@ -944,6 +944,26 @@ {"shape":"InternalServerException"} ] }, + "StopBotRecommendation":{ + "name":"StopBotRecommendation", + "http":{ + "method":"PUT", + "requestUri":"/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/stopbotrecommendation", + "responseCode":202 + }, + "input":{"shape":"StopBotRecommendationRequest"}, + "output":{"shape":"StopBotRecommendationResponse"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"} + ] + }, "TagResource":{ "name":"TagResource", "http":{ @@ -1545,7 +1565,9 @@ "Downloading", "Updating", "Available", - "Failed" + "Failed", + "Stopping", + "Stopped" ] }, "BotRecommendationSummary":{ @@ -5073,6 +5095,47 @@ "max":900, "min":1 }, + "StopBotRecommendationRequest":{ + "type":"structure", + "required":[ + "botId", + "botVersion", + "localeId", + "botRecommendationId" + ], + "members":{ + "botId":{ + "shape":"Id", + "location":"uri", + "locationName":"botId" + }, + "botVersion":{ + "shape":"DraftBotVersion", + "location":"uri", + "locationName":"botVersion" + }, + "localeId":{ + "shape":"LocaleId", + "location":"uri", + "locationName":"localeId" + }, + "botRecommendationId":{ + "shape":"Id", + "location":"uri", + "locationName":"botRecommendationId" + } + } + }, + "StopBotRecommendationResponse":{ + "type":"structure", + "members":{ + "botId":{"shape":"Id"}, + "botVersion":{"shape":"DraftBotVersion"}, + "localeId":{"shape":"LocaleId"}, + "botRecommendationStatus":{"shape":"BotRecommendationStatus"}, + "botRecommendationId":{"shape":"Id"} + } + }, "String":{"type":"string"}, "StringMap":{ "type":"map", 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 9fa1798b85..07e2f222bf 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 @@ -57,6 +57,7 @@ "SearchAssociatedTranscripts": "

Search for associated transcripts that meet the specified criteria.

", "StartBotRecommendation": "

Use this to provide your transcript data, and to start the bot recommendation process.

", "StartImport": "

Starts importing a bot, bot locale, or custom vocabulary from a zip archive that you uploaded to an S3 bucket.

", + "StopBotRecommendation": "

Stop an already running Bot Recommendation request.

", "TagResource": "

Adds the specified tags to the specified resource. If a tag key already exists, the existing value is replaced with the new value.

", "UntagResource": "

Removes tags from a bot, bot alias, or bot channel.

", "UpdateBot": "

Updates the configuration of an existing bot.

", @@ -432,6 +433,7 @@ "BotRecommendationSummary$botRecommendationStatus": "

The status of the bot recommendation.

If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

", "DescribeBotRecommendationResponse$botRecommendationStatus": "

The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

", "StartBotRecommendationResponse$botRecommendationStatus": "

The status of the bot recommendation.

If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

", + "StopBotRecommendationResponse$botRecommendationStatus": "

The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

", "UpdateBotRecommendationResponse$botRecommendationStatus": "

The status of the bot recommendation.

If the status is Failed, then the reasons for the failure are listed in the failureReasons field.

" } }, @@ -1358,6 +1360,8 @@ "ListRecommendedIntentsResponse$botVersion": "

The version of the bot that contains the intent.

", "StartBotRecommendationRequest$botVersion": "

The version of the bot containing the bot recommendation.

", "StartBotRecommendationResponse$botVersion": "

The version of the bot containing the bot recommendation.

", + "StopBotRecommendationRequest$botVersion": "

The version of the bot containing the bot recommendation.

", + "StopBotRecommendationResponse$botVersion": "

The version of the bot containing the recommendation that is being stopped.

", "UpdateBotLocaleRequest$botVersion": "

The version of the bot that contains the locale to be updated. The version can only be the DRAFT version.

", "UpdateBotLocaleResponse$botVersion": "

The version of the bot that contains the updated locale.

", "UpdateBotRecommendationRequest$botVersion": "

The version of the bot containing the bot recommendation to be updated.

", @@ -1719,6 +1723,10 @@ "StartBotRecommendationResponse$botRecommendationId": "

The identifier of the bot recommendation that you have created.

", "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.

", + "StopBotRecommendationRequest$botId": "

The unique identifier of the bot containing the bot recommendation to be stopped.

", + "StopBotRecommendationRequest$botRecommendationId": "

The unique identifier of the bot recommendation to be stopped.

", + "StopBotRecommendationResponse$botId": "

The unique identifier of the bot containing the bot recommendation that is being stopped.

", + "StopBotRecommendationResponse$botRecommendationId": "

The unique identifier of the bot recommendation that is being stopped.

", "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.

", @@ -2230,6 +2238,8 @@ "SearchAssociatedTranscriptsResponse$localeId": "

The identifier of the language and locale of the transcripts to search. The string must match one of the supported locales. For more information, see Supported languages

", "StartBotRecommendationRequest$localeId": "

The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages

", "StartBotRecommendationResponse$localeId": "

The identifier of the language and locale of the bot recommendation to start. The string must match one of the supported locales. For more information, see Supported languages

", + "StopBotRecommendationRequest$localeId": "

The identifier of the language and locale of the bot recommendation to stop. The string must match one of the supported locales. For more information, see Supported languages

", + "StopBotRecommendationResponse$localeId": "

The identifier of the language and locale of the bot response to stop. The string must match one of the supported locales. For more information, see Supported languages

", "UpdateBotLocaleRequest$localeId": "

The identifier of the language and locale to update. The string must match one of the supported locales. For more information, see Supported languages.

", "UpdateBotLocaleResponse$localeId": "

The language and locale of the updated bot locale.

", "UpdateBotRecommendationRequest$localeId": "

The identifier of the language and locale of the bot recommendation to update. The string must match one of the supported locales. For more information, see Supported languages

", @@ -3146,6 +3156,16 @@ "StillWaitingResponseSpecification$timeoutInSeconds": "

If Amazon Lex waits longer than this length of time for a response, it will stop sending messages.

" } }, + "StopBotRecommendationRequest": { + "base": null, + "refs": { + } + }, + "StopBotRecommendationResponse": { + "base": null, + "refs": { + } + }, "String": { "base": null, "refs": { diff --git a/models/apis/securityhub/2018-10-26/api-2.json b/models/apis/securityhub/2018-10-26/api-2.json index 3086459fd6..c8ef16bc30 100644 --- a/models/apis/securityhub/2018-10-26/api-2.json +++ b/models/apis/securityhub/2018-10-26/api-2.json @@ -1337,6 +1337,134 @@ "HttpTokens":{"shape":"NonEmptyString"} } }, + "AwsBackupBackupPlanAdvancedBackupSettingsDetails":{ + "type":"structure", + "members":{ + "BackupOptions":{"shape":"FieldMap"}, + "ResourceType":{"shape":"NonEmptyString"} + } + }, + "AwsBackupBackupPlanAdvancedBackupSettingsList":{ + "type":"list", + "member":{"shape":"AwsBackupBackupPlanAdvancedBackupSettingsDetails"} + }, + "AwsBackupBackupPlanBackupPlanDetails":{ + "type":"structure", + "members":{ + "BackupPlanName":{"shape":"NonEmptyString"}, + "AdvancedBackupSettings":{"shape":"AwsBackupBackupPlanAdvancedBackupSettingsList"}, + "BackupPlanRule":{"shape":"AwsBackupBackupPlanRuleList"} + } + }, + "AwsBackupBackupPlanDetails":{ + "type":"structure", + "members":{ + "BackupPlan":{"shape":"AwsBackupBackupPlanBackupPlanDetails"}, + "BackupPlanArn":{"shape":"NonEmptyString"}, + "BackupPlanId":{"shape":"NonEmptyString"}, + "VersionId":{"shape":"NonEmptyString"} + } + }, + "AwsBackupBackupPlanLifecycleDetails":{ + "type":"structure", + "members":{ + "DeleteAfterDays":{"shape":"Long"}, + "MoveToColdStorageAfterDays":{"shape":"Long"} + } + }, + "AwsBackupBackupPlanRuleCopyActionsDetails":{ + "type":"structure", + "members":{ + "DestinationBackupVaultArn":{"shape":"NonEmptyString"}, + "Lifecycle":{"shape":"AwsBackupBackupPlanLifecycleDetails"} + } + }, + "AwsBackupBackupPlanRuleCopyActionsList":{ + "type":"list", + "member":{"shape":"AwsBackupBackupPlanRuleCopyActionsDetails"} + }, + "AwsBackupBackupPlanRuleDetails":{ + "type":"structure", + "members":{ + "TargetBackupVault":{"shape":"NonEmptyString"}, + "StartWindowMinutes":{"shape":"Long"}, + "ScheduleExpression":{"shape":"NonEmptyString"}, + "RuleName":{"shape":"NonEmptyString"}, + "RuleId":{"shape":"NonEmptyString"}, + "EnableContinuousBackup":{"shape":"Boolean"}, + "CompletionWindowMinutes":{"shape":"Long"}, + "CopyActions":{"shape":"AwsBackupBackupPlanRuleCopyActionsList"}, + "Lifecycle":{"shape":"AwsBackupBackupPlanLifecycleDetails"} + } + }, + "AwsBackupBackupPlanRuleList":{ + "type":"list", + "member":{"shape":"AwsBackupBackupPlanRuleDetails"} + }, + "AwsBackupBackupVaultDetails":{ + "type":"structure", + "members":{ + "BackupVaultArn":{"shape":"NonEmptyString"}, + "BackupVaultName":{"shape":"NonEmptyString"}, + "EncryptionKeyArn":{"shape":"NonEmptyString"}, + "Notifications":{"shape":"AwsBackupBackupVaultNotificationsDetails"}, + "AccessPolicy":{"shape":"NonEmptyString"} + } + }, + "AwsBackupBackupVaultNotificationsDetails":{ + "type":"structure", + "members":{ + "BackupVaultEvents":{"shape":"NonEmptyStringList"}, + "SnsTopicArn":{"shape":"NonEmptyString"} + } + }, + "AwsBackupRecoveryPointCalculatedLifecycleDetails":{ + "type":"structure", + "members":{ + "DeleteAt":{"shape":"NonEmptyString"}, + "MoveToColdStorageAt":{"shape":"NonEmptyString"} + } + }, + "AwsBackupRecoveryPointCreatedByDetails":{ + "type":"structure", + "members":{ + "BackupPlanArn":{"shape":"NonEmptyString"}, + "BackupPlanId":{"shape":"NonEmptyString"}, + "BackupPlanVersion":{"shape":"NonEmptyString"}, + "BackupRuleId":{"shape":"NonEmptyString"} + } + }, + "AwsBackupRecoveryPointDetails":{ + "type":"structure", + "members":{ + "BackupSizeInBytes":{"shape":"Long"}, + "BackupVaultArn":{"shape":"NonEmptyString"}, + "BackupVaultName":{"shape":"NonEmptyString"}, + "CalculatedLifecycle":{"shape":"AwsBackupRecoveryPointCalculatedLifecycleDetails"}, + "CompletionDate":{"shape":"NonEmptyString"}, + "CreatedBy":{"shape":"AwsBackupRecoveryPointCreatedByDetails"}, + "CreationDate":{"shape":"NonEmptyString"}, + "EncryptionKeyArn":{"shape":"NonEmptyString"}, + "IamRoleArn":{"shape":"NonEmptyString"}, + "IsEncrypted":{"shape":"Boolean"}, + "LastRestoreTime":{"shape":"NonEmptyString"}, + "Lifecycle":{"shape":"AwsBackupRecoveryPointLifecycleDetails"}, + "RecoveryPointArn":{"shape":"NonEmptyString"}, + "ResourceArn":{"shape":"NonEmptyString"}, + "ResourceType":{"shape":"NonEmptyString"}, + "SourceBackupVaultArn":{"shape":"NonEmptyString"}, + "Status":{"shape":"NonEmptyString"}, + "StatusMessage":{"shape":"NonEmptyString"}, + "StorageClass":{"shape":"NonEmptyString"} + } + }, + "AwsBackupRecoveryPointLifecycleDetails":{ + "type":"structure", + "members":{ + "DeleteAfterDays":{"shape":"Long"}, + "MoveToColdStorageAfterDays":{"shape":"Long"} + } + }, "AwsCertificateManagerCertificateDetails":{ "type":"structure", "members":{ @@ -6947,7 +7075,10 @@ "AwsWafRegionalWebAcl":{"shape":"AwsWafRegionalWebAclDetails"}, "AwsWafRule":{"shape":"AwsWafRuleDetails"}, "AwsWafRuleGroup":{"shape":"AwsWafRuleGroupDetails"}, - "AwsEcsTask":{"shape":"AwsEcsTaskDetails"} + "AwsEcsTask":{"shape":"AwsEcsTaskDetails"}, + "AwsBackupBackupVault":{"shape":"AwsBackupBackupVaultDetails"}, + "AwsBackupBackupPlan":{"shape":"AwsBackupBackupPlanDetails"}, + "AwsBackupRecoveryPoint":{"shape":"AwsBackupRecoveryPointDetails"} } }, "ResourceList":{ @@ -7233,7 +7364,9 @@ "Release":{"shape":"NonEmptyString"}, "Architecture":{"shape":"NonEmptyString"}, "PackageManager":{"shape":"NonEmptyString"}, - "FilePath":{"shape":"NonEmptyString"} + "FilePath":{"shape":"NonEmptyString"}, + "FixedInVersion":{"shape":"NonEmptyString"}, + "Remediation":{"shape":"NonEmptyString"} } }, "SoftwarePackageList":{ @@ -7718,9 +7851,18 @@ "Cvss":{"shape":"CvssList"}, "RelatedVulnerabilities":{"shape":"StringList"}, "Vendor":{"shape":"VulnerabilityVendor"}, - "ReferenceUrls":{"shape":"StringList"} + "ReferenceUrls":{"shape":"StringList"}, + "FixAvailable":{"shape":"VulnerabilityFixAvailable"} } }, + "VulnerabilityFixAvailable":{ + "type":"string", + "enum":[ + "YES", + "NO", + "PARTIAL" + ] + }, "VulnerabilityList":{ "type":"list", "member":{"shape":"Vulnerability"} diff --git a/models/apis/securityhub/2018-10-26/docs-2.json b/models/apis/securityhub/2018-10-26/docs-2.json index 1fd0eb27f7..abf856f4d6 100644 --- a/models/apis/securityhub/2018-10-26/docs-2.json +++ b/models/apis/securityhub/2018-10-26/docs-2.json @@ -394,6 +394,97 @@ "AwsAutoScalingLaunchConfigurationDetails$MetadataOptions": "

The metadata options for the instances.

" } }, + "AwsBackupBackupPlanAdvancedBackupSettingsDetails": { + "base": "

Provides a list of backup options for each resource type.

", + "refs": { + "AwsBackupBackupPlanAdvancedBackupSettingsList$member": null + } + }, + "AwsBackupBackupPlanAdvancedBackupSettingsList": { + "base": null, + "refs": { + "AwsBackupBackupPlanBackupPlanDetails$AdvancedBackupSettings": "

A list of backup options for each resource type.

" + } + }, + "AwsBackupBackupPlanBackupPlanDetails": { + "base": "

Provides details about an Backup backup plan and an array of BackupRule objects, each of which specifies a backup rule.

", + "refs": { + "AwsBackupBackupPlanDetails$BackupPlan": "

Uniquely identifies the backup plan to be associated with the selection of resources.

" + } + }, + "AwsBackupBackupPlanDetails": { + "base": "

Provides details about an Backup backup plan and an array of BackupRule objects, each of which specifies a backup rule.

", + "refs": { + "ResourceDetails$AwsBackupBackupPlan": "

Provides details about an Backup backup plan.

" + } + }, + "AwsBackupBackupPlanLifecycleDetails": { + "base": "

Provides lifecycle details for the backup plan. A lifecycle defines when a backup is transitioned to cold storage and when it expires.

", + "refs": { + "AwsBackupBackupPlanRuleCopyActionsDetails$Lifecycle": "

Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

", + "AwsBackupBackupPlanRuleDetails$Lifecycle": "

Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.

" + } + }, + "AwsBackupBackupPlanRuleCopyActionsDetails": { + "base": "

An array of CopyAction objects, which contains the details of the copy operation.

", + "refs": { + "AwsBackupBackupPlanRuleCopyActionsList$member": null + } + }, + "AwsBackupBackupPlanRuleCopyActionsList": { + "base": null, + "refs": { + "AwsBackupBackupPlanRuleDetails$CopyActions": "

An array of CopyAction objects, which contains the details of the copy operation.

" + } + }, + "AwsBackupBackupPlanRuleDetails": { + "base": "

Provides details about an array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

", + "refs": { + "AwsBackupBackupPlanRuleList$member": null + } + }, + "AwsBackupBackupPlanRuleList": { + "base": null, + "refs": { + "AwsBackupBackupPlanBackupPlanDetails$BackupPlanRule": "

An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.

" + } + }, + "AwsBackupBackupVaultDetails": { + "base": "

Provides details about an Backup backup vault. In Backup, a backup vault is a container that stores and organizes your backups.

", + "refs": { + "ResourceDetails$AwsBackupBackupVault": "

Provides details about an Backup backup vault.

" + } + }, + "AwsBackupBackupVaultNotificationsDetails": { + "base": "

Provides details about the Amazon SNS event notifications for the specified backup vault.

", + "refs": { + "AwsBackupBackupVaultDetails$Notifications": "

The Amazon SNS event notifications for the specified backup vault.

" + } + }, + "AwsBackupRecoveryPointCalculatedLifecycleDetails": { + "base": "

Specifies how long in days before a recovery point transitions to cold storage or is deleted.

", + "refs": { + "AwsBackupRecoveryPointDetails$CalculatedLifecycle": "

A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.

" + } + }, + "AwsBackupRecoveryPointCreatedByDetails": { + "base": "

Contains information about the backup plan and rule that Backup used to initiate the recovery point backup.

", + "refs": { + "AwsBackupRecoveryPointDetails$CreatedBy": "

Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

" + } + }, + "AwsBackupRecoveryPointDetails": { + "base": "

Contains detailed information about the recovery points stored in an Backup backup vault. A backup, or recovery point, represents the content of a resource at a specified time.

", + "refs": { + "ResourceDetails$AwsBackupRecoveryPoint": "

Provides details about an Backup backup, or recovery point.

" + } + }, + "AwsBackupRecoveryPointLifecycleDetails": { + "base": "

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted.

", + "refs": { + "AwsBackupRecoveryPointDetails$Lifecycle": "

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define

" + } + }, "AwsCertificateManagerCertificateDetails": { "base": "

Provides details about an Certificate Manager certificate.

", "refs": { @@ -2885,7 +2976,7 @@ } }, "AwsSecurityFinding": { - "base": "

Provides consistent format for the contents of the Security Hub-aggregated findings. AwsSecurityFinding format enables you to share findings between Amazon Web Services security services and third-party solutions, and security standards checks.

A finding is a potential security issue generated either by Amazon Web Services services or by the integrated third-party solutions and standards checks.

", + "base": "

Provides a consistent format for Security Hub findings. AwsSecurityFinding format allows you to share findings between Amazon Web Services security services and third-party solutions.

A finding is a potential security issue generated either by Amazon Web Services services or by the integrated third-party solutions and standards checks.

", "refs": { "AwsSecurityFindingList$member": null, "BatchImportFindingsRequestFindingList$member": null @@ -3217,6 +3308,8 @@ "AwsAutoScalingLaunchConfigurationDetails$AssociatePublicIpAddress": "

For Auto Scaling groups that run in a VPC, specifies whether to assign a public IP address to the group's instances.

", "AwsAutoScalingLaunchConfigurationDetails$EbsOptimized": "

Whether the launch configuration is optimized for Amazon EBS I/O.

", "AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails$Enabled": "

If set to true, then instances in the group launch with detailed monitoring.

If set to false, then instances in the group launch with basic monitoring.

", + "AwsBackupBackupPlanRuleDetails$EnableContinuousBackup": "

Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).

", + "AwsBackupRecoveryPointDetails$IsEncrypted": "

A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.

", "AwsCloudFormationStackDetails$DisableRollback": "

Boolean to enable or disable rollback on stack creation failures.

", "AwsCloudFormationStackDetails$EnableTerminationProtection": "

Whether termination protection is enabled for the stack.

", "AwsCloudFrontDistributionLogging$Enabled": "

With this field, you can enable or disable the selected distribution.

", @@ -3813,6 +3906,7 @@ "AwsApiGatewayCanarySettings$StageVariableOverrides": "

Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary.

Each variable is represented as a string-to-string map between the stage variable name and the variable value.

", "AwsApiGatewayStageDetails$Variables": "

A map that defines the stage variables for the stage.

Variable names can have alphanumeric and underscore characters.

Variable values can contain the following characters:

", "AwsApiGatewayV2StageDetails$StageVariables": "

A map that defines the stage variables for the stage.

Variable names can have alphanumeric and underscore characters.

Variable values can contain the following characters:

", + "AwsBackupBackupPlanAdvancedBackupSettingsDetails$BackupOptions": "

Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs. Valid values are as follows:

", "AwsEcsTaskDefinitionContainerDefinitionsDetails$DockerLabels": "

A key-value map of labels to add to the container.

", "AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails$Options": "

The options to use to configure the log router.

The valid option keys are as follows:

", "AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails$Options": "

The configuration options to send to the log driver. Requires version 1.19 of the Docker Remote API or greater on your container instance.

", @@ -4157,7 +4251,7 @@ "AwsOpenSearchServiceDomainClusterConfigDetails$InstanceCount": "

The number of data nodes to use in the OpenSearch domain.

", "AwsOpenSearchServiceDomainClusterConfigDetails$WarmCount": "

The number of UltraWarm instances.

", "AwsOpenSearchServiceDomainClusterConfigDetails$DedicatedMasterCount": "

The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.

", - "AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails$AvailabilityZoneCount": "

The number of Availability Zones that the domain uses. Valid values are 2 and 3. The default is 2.

", + "AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails$AvailabilityZoneCount": "

The number of Availability Zones that the domain uses. Valid values are 2 or 3. The default is 2.

", "AwsRdsDbClusterDetails$AllocatedStorage": "

For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).

", "AwsRdsDbClusterDetails$BackupRetentionPeriod": "

The number of days for which automated backups are retained.

", "AwsRdsDbClusterDetails$Port": "

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

", @@ -4429,6 +4523,13 @@ "Long": { "base": null, "refs": { + "AwsBackupBackupPlanLifecycleDetails$DeleteAfterDays": "

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

", + "AwsBackupBackupPlanLifecycleDetails$MoveToColdStorageAfterDays": "

Specifies the number of days after creation that a recovery point is moved to cold storage.

", + "AwsBackupBackupPlanRuleDetails$StartWindowMinutes": "

A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.

", + "AwsBackupBackupPlanRuleDetails$CompletionWindowMinutes": "

A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.

", + "AwsBackupRecoveryPointDetails$BackupSizeInBytes": "

The size, in bytes, of a backup.

", + "AwsBackupRecoveryPointLifecycleDetails$DeleteAfterDays": "

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

", + "AwsBackupRecoveryPointLifecycleDetails$MoveToColdStorageAfterDays": "

Specifies the number of days after creation that a recovery point is moved to cold storage.

", "AwsElbLbCookieStickinessPolicy$CookieExpirationPeriod": "

The amount of time, in seconds, after which the cookie is considered stale. If an expiration period is not specified, the stickiness session lasts for the duration of the browser session.

", "AwsRedshiftClusterRestoreStatus$ElapsedTimeInSeconds": "

The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish.

This field is only updated when you restore to DC2 and DS2 node types.

", "AwsRedshiftClusterRestoreStatus$EstimatedTimeToCompletionInSeconds": "

The estimate of the time remaining before the restore is complete. Returns 0 for a completed restore.

This field is only updated when you restore to DC2 and DS2 node types.

", @@ -4666,13 +4767,13 @@ "AwsApiGatewayV2StageDetails$LastDeploymentStatusMessage": "

The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.

", "AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails$Value": "

The name of the Availability Zone.

", "AwsAutoScalingAutoScalingGroupDetails$LaunchConfigurationName": "

The name of the launch configuration.

", - "AwsAutoScalingAutoScalingGroupDetails$HealthCheckType": "

The service to use for the health checks.

", + "AwsAutoScalingAutoScalingGroupDetails$HealthCheckType": "

The service to use for the health checks. Valid values are EC2 or ELB.

", "AwsAutoScalingAutoScalingGroupDetails$CreatedTime": "

Indicates when the auto scaling group was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

", "AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification$LaunchTemplateId": "

The identifier of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

", "AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification$LaunchTemplateName": "

The name of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

", "AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification$Version": "

Identifies the version of the launch template. You can specify a version identifier, or use the values $Latest or $Default.

", - "AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails$OnDemandAllocationStrategy": "

How to allocate instance types to fulfill On-Demand capacity.

", - "AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails$SpotAllocationStrategy": "

How to allocate instances across Spot Instance pools.

", + "AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails$OnDemandAllocationStrategy": "

How to allocate instance types to fulfill On-Demand capacity. The valid value is prioritized.

", + "AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails$SpotAllocationStrategy": "

How to allocate instances across Spot Instance pools. Valid values are as follows:

", "AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails$SpotMaxPrice": "

The maximum price per unit hour that you are willing to pay for a Spot Instance.

", "AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification$LaunchTemplateId": "

The identifier of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

", "AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification$LaunchTemplateName": "

The name of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.

", @@ -4682,7 +4783,7 @@ "AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails$DeviceName": "

The device name that is exposed to the EC2 instance. For example, /dev/sdh or xvdh.

", "AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails$VirtualName": "

The name of the virtual device (for example, ephemeral0).

You can provide either VirtualName or Ebs, but not both.

", "AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails$SnapshotId": "

The snapshot ID of the volume to use.

You must specify either VolumeSize or SnapshotId.

", - "AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails$VolumeType": "

The volume type.

", + "AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails$VolumeType": "

The volume type. Valid values are as follows:

", "AwsAutoScalingLaunchConfigurationDetails$ClassicLinkVpcId": "

The identifier of a ClassicLink-enabled VPC that EC2-Classic instances are linked to.

", "AwsAutoScalingLaunchConfigurationDetails$CreatedTime": "

The creation date and time for the launch configuration.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

", "AwsAutoScalingLaunchConfigurationDetails$IamInstanceProfile": "

The name or the ARN of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.

", @@ -4697,6 +4798,41 @@ "AwsAutoScalingLaunchConfigurationDetails$UserData": "

The user data to make available to the launched EC2 instances. Must be base64-encoded text.

", "AwsAutoScalingLaunchConfigurationMetadataOptions$HttpEndpoint": "

Enables or disables the HTTP metadata endpoint on your instances. By default, the metadata endpoint is enabled.

", "AwsAutoScalingLaunchConfigurationMetadataOptions$HttpTokens": "

Indicates whether token usage is required or optional for metadata requests. By default, token usage is optional.

", + "AwsBackupBackupPlanAdvancedBackupSettingsDetails$ResourceType": "

The name of a resource type. The only supported resource type is Amazon EC2 instances with Windows VSS.

The only valid value is EC2.

", + "AwsBackupBackupPlanBackupPlanDetails$BackupPlanName": "

The display name of a backup plan.

", + "AwsBackupBackupPlanDetails$BackupPlanArn": "

An Amazon Resource Name (ARN) that uniquely identifies the backup plan.

", + "AwsBackupBackupPlanDetails$BackupPlanId": "

A unique ID for the backup plan.

", + "AwsBackupBackupPlanDetails$VersionId": "

Unique, randomly generated, Unicode, UTF-8 encoded strings. Version IDs cannot be edited.

", + "AwsBackupBackupPlanRuleCopyActionsDetails$DestinationBackupVaultArn": "

An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup.

", + "AwsBackupBackupPlanRuleDetails$TargetBackupVault": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.

", + "AwsBackupBackupPlanRuleDetails$ScheduleExpression": "

A cron expression in UTC specifying when Backup initiates a backup job.

", + "AwsBackupBackupPlanRuleDetails$RuleName": "

A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.

", + "AwsBackupBackupPlanRuleDetails$RuleId": "

Uniquely identifies a rule that is used to schedule the backup of a selection of resources.

", + "AwsBackupBackupVaultDetails$BackupVaultArn": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault.

", + "AwsBackupBackupVaultDetails$BackupVaultName": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "AwsBackupBackupVaultDetails$EncryptionKeyArn": "

The unique ARN associated with the server-side encryption key. You can specify a key to encrypt your backups from services that support full Backup management. If you do not specify a key, Backup creates an KMS key for you by default.

", + "AwsBackupBackupVaultDetails$AccessPolicy": "

A resource-based policy that is used to manage access permissions on the target backup vault.

", + "AwsBackupBackupVaultNotificationsDetails$SnsTopicArn": "

An ARN that uniquely identifies the Amazon SNS topic for a backup vault’s events.

", + "AwsBackupRecoveryPointCalculatedLifecycleDetails$DeleteAt": "

Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.

", + "AwsBackupRecoveryPointCalculatedLifecycleDetails$MoveToColdStorageAt": "

Specifies the number of days after creation that a recovery point is moved to cold storage.

", + "AwsBackupRecoveryPointCreatedByDetails$BackupPlanArn": "

An Amazon Resource Name (ARN) that uniquely identifies a backup plan.

", + "AwsBackupRecoveryPointCreatedByDetails$BackupPlanId": "

Uniquely identifies a backup plan.

", + "AwsBackupRecoveryPointCreatedByDetails$BackupPlanVersion": "

Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.

", + "AwsBackupRecoveryPointCreatedByDetails$BackupRuleId": "

Uniquely identifies a rule used to schedule the backup of a selection of resources.

", + "AwsBackupRecoveryPointDetails$BackupVaultArn": "

An Amazon Resource Name (ARN) that uniquely identifies a backup vault.

", + "AwsBackupRecoveryPointDetails$BackupVaultName": "

The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.

", + "AwsBackupRecoveryPointDetails$CompletionDate": "

The date and time that a job to create a recovery point is completed, in Unix format and UTC. The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

", + "AwsBackupRecoveryPointDetails$CreationDate": "

The date and time a recovery point is created, in Unix format and UTC. The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

", + "AwsBackupRecoveryPointDetails$EncryptionKeyArn": "

The ARN for the server-side encryption key that is used to protect your backups.

", + "AwsBackupRecoveryPointDetails$IamRoleArn": "

Specifies the IAM role ARN used to create the target recovery point

", + "AwsBackupRecoveryPointDetails$LastRestoreTime": "

The date and time that a recovery point was last restored, in Unix format and UTC. The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

", + "AwsBackupRecoveryPointDetails$RecoveryPointArn": "

An ARN that uniquely identifies a recovery point.

", + "AwsBackupRecoveryPointDetails$ResourceArn": "

An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.

", + "AwsBackupRecoveryPointDetails$ResourceType": "

The type of Amazon Web Services resource saved as a recovery point, such as an Amazon EBS volume or an Amazon RDS database.

", + "AwsBackupRecoveryPointDetails$SourceBackupVaultArn": "

The ARN for the backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account, this value will be null.

", + "AwsBackupRecoveryPointDetails$Status": "

A status code specifying the state of the recovery point. Valid values are as follows:

", + "AwsBackupRecoveryPointDetails$StatusMessage": "

A message explaining the reason of the recovery point deletion failure.

", + "AwsBackupRecoveryPointDetails$StorageClass": "

Specifies the storage class of the recovery point. Valid values are as follows:

", "AwsCertificateManagerCertificateDetails$CertificateAuthorityArn": "

The ARN of the private certificate authority (CA) that will be used to issue the certificate.

", "AwsCertificateManagerCertificateDetails$CreatedAt": "

Indicates when the certificate was requested.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

", "AwsCertificateManagerCertificateDetails$DomainName": "

The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.

", @@ -4722,7 +4858,7 @@ "AwsCertificateManagerCertificateKeyUsage$Name": "

The key usage extension name.

", "AwsCertificateManagerCertificateOptions$CertificateTransparencyLoggingPreference": "

Whether to add the certificate to a transparency log.

Valid values: DISABLED | ENABLED

", "AwsCertificateManagerCertificateRenewalSummary$RenewalStatus": "

The status of the Certificate Manager managed renewal of the certificate.

Valid values: PENDING_AUTO_RENEWAL | PENDING_VALIDATION | SUCCESS | FAILED

", - "AwsCertificateManagerCertificateRenewalSummary$RenewalStatusReason": "

The reason that a renewal request was unsuccessful.

Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER

", + "AwsCertificateManagerCertificateRenewalSummary$RenewalStatusReason": "

The reason that a renewal request was unsuccessful. This attribute is used only when RenewalStatus is FAILED.

Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER

", "AwsCertificateManagerCertificateRenewalSummary$UpdatedAt": "

Indicates when the renewal summary was last updated.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

", "AwsCertificateManagerCertificateResourceRecord$Name": "

The name of the resource.

", "AwsCertificateManagerCertificateResourceRecord$Type": "

The type of resource.

", @@ -4821,20 +4957,20 @@ "AwsDynamoDbTableDetails$LatestStreamLabel": "

The label of the latest stream. The label is not a unique identifier.

", "AwsDynamoDbTableDetails$TableId": "

The identifier of the table.

", "AwsDynamoDbTableDetails$TableName": "

The name of the table.

", - "AwsDynamoDbTableDetails$TableStatus": "

The current status of the table.

", + "AwsDynamoDbTableDetails$TableStatus": "

The current status of the table. Valid values are as follows:

", "AwsDynamoDbTableGlobalSecondaryIndex$IndexArn": "

The ARN of the index.

", "AwsDynamoDbTableGlobalSecondaryIndex$IndexName": "

The name of the index.

", - "AwsDynamoDbTableGlobalSecondaryIndex$IndexStatus": "

The current status of the index.

", + "AwsDynamoDbTableGlobalSecondaryIndex$IndexStatus": "

The current status of the index.

", "AwsDynamoDbTableKeySchema$AttributeName": "

The name of the key schema attribute.

", - "AwsDynamoDbTableKeySchema$KeyType": "

The type of key used for the key schema attribute.

", + "AwsDynamoDbTableKeySchema$KeyType": "

The type of key used for the key schema attribute. Valid values are HASH or RANGE.

", "AwsDynamoDbTableLocalSecondaryIndex$IndexArn": "

The ARN of the index.

", "AwsDynamoDbTableLocalSecondaryIndex$IndexName": "

The name of the index.

", - "AwsDynamoDbTableProjection$ProjectionType": "

The types of attributes that are projected into the index.

", + "AwsDynamoDbTableProjection$ProjectionType": "

The types of attributes that are projected into the index. Valid values are as follows:

", "AwsDynamoDbTableProvisionedThroughput$LastDecreaseDateTime": "

Indicates when the provisioned throughput was last decreased.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

", "AwsDynamoDbTableProvisionedThroughput$LastIncreaseDateTime": "

Indicates when the provisioned throughput was last increased.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

", "AwsDynamoDbTableReplica$KmsMasterKeyId": "

The identifier of the KMS key that will be used for KMS encryption for the replica.

", "AwsDynamoDbTableReplica$RegionName": "

The name of the Region where the replica is located.

", - "AwsDynamoDbTableReplica$ReplicaStatus": "

The current status of the replica.

", + "AwsDynamoDbTableReplica$ReplicaStatus": "

The current status of the replica. Valid values are as follows:

", "AwsDynamoDbTableReplica$ReplicaStatusDescription": "

Detailed information about the replica status.

", "AwsDynamoDbTableReplicaGlobalSecondaryIndex$IndexName": "

The name of the index.

", "AwsDynamoDbTableRestoreSummary$SourceBackupArn": "

The ARN of the source backup from which the table was restored.

", @@ -4909,7 +5045,7 @@ "AwsEc2SubnetDetails$AvailabilityZoneId": "

The identifier of the Availability Zone for the subnet.

", "AwsEc2SubnetDetails$CidrBlock": "

The IPV4 CIDR block that is assigned to the subnet.

", "AwsEc2SubnetDetails$OwnerId": "

The identifier of the Amazon Web Services account that owns the subnet.

", - "AwsEc2SubnetDetails$State": "

The current state of the subnet.

", + "AwsEc2SubnetDetails$State": "

The current state of the subnet. Valid values are available or pending.

", "AwsEc2SubnetDetails$SubnetArn": "

The ARN of the subnet.

", "AwsEc2SubnetDetails$SubnetId": "

The identifier of the subnet.

", "AwsEc2SubnetDetails$VpcId": "

The identifier of the VPC that contains the subnet.

", @@ -4925,21 +5061,21 @@ "AwsEc2TransitGatewayDetails$MulticastSupport": "

Indicates whether multicast is supported on the transit gateway.

", "AwsEc2VolumeAttachment$AttachTime": "

The datetime when the attachment initiated.

", "AwsEc2VolumeAttachment$InstanceId": "

The identifier of the EC2 instance.

", - "AwsEc2VolumeAttachment$Status": "

The attachment state of the volume.

", + "AwsEc2VolumeAttachment$Status": "

The attachment state of the volume. Valid values are as follows:

", "AwsEc2VolumeDetails$CreateTime": "

Indicates when the volume was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

", "AwsEc2VolumeDetails$DeviceName": "

The device name for the volume that is attached to the instance.

", "AwsEc2VolumeDetails$SnapshotId": "

The snapshot from which the volume was created.

", - "AwsEc2VolumeDetails$Status": "

The volume state.

", + "AwsEc2VolumeDetails$Status": "

The volume state. Valid values are as follows:

", "AwsEc2VolumeDetails$KmsKeyId": "

The ARN of the KMS key that was used to protect the volume encryption key for the volume.

", "AwsEc2VolumeDetails$VolumeId": "

The ID of the volume.

", "AwsEc2VolumeDetails$VolumeType": "

The volume type.

", "AwsEc2VolumeDetails$VolumeScanStatus": "

Indicates whether the volume was scanned or skipped.

", "AwsEc2VpcDetails$DhcpOptionsId": "

The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options that are associated with the VPC. If the default options are associated with the VPC, then this is default.

", - "AwsEc2VpcDetails$State": "

The current state of the VPC.

", + "AwsEc2VpcDetails$State": "

The current state of the VPC. Valid values are available or pending.

", "AwsEc2VpcEndpointServiceDetails$PrivateDnsName": "

The private DNS name for the service.

", "AwsEc2VpcEndpointServiceDetails$ServiceId": "

The identifier of the service.

", "AwsEc2VpcEndpointServiceDetails$ServiceName": "

The name of the service.

", - "AwsEc2VpcEndpointServiceDetails$ServiceState": "

The current state of the service.

", + "AwsEc2VpcEndpointServiceDetails$ServiceState": "

The current state of the service. Valid values are as follows:

", "AwsEc2VpcEndpointServiceServiceTypeDetails$ServiceType": "

The type of service.

", "AwsEc2VpcPeeringConnectionDetails$ExpirationTime": "

The time at which an unaccepted VPC peering connection will expire.

", "AwsEc2VpcPeeringConnectionDetails$VpcPeeringConnectionId": "

The ID of the VPC peering connection.

", @@ -4950,7 +5086,7 @@ "AwsEc2VpcPeeringConnectionVpcInfoDetails$Region": "

The Amazon Web Services Region in which the VPC is located.

", "AwsEc2VpcPeeringConnectionVpcInfoDetails$VpcId": "

The ID of the VPC.

", "AwsEc2VpnConnectionDetails$VpnConnectionId": "

The identifier of the VPN connection.

", - "AwsEc2VpnConnectionDetails$State": "

The current state of the VPN connection.

", + "AwsEc2VpnConnectionDetails$State": "

The current state of the VPN connection. Valid values are as follows:

", "AwsEc2VpnConnectionDetails$CustomerGatewayId": "

The identifier of the customer gateway that is at your end of the VPN connection.

", "AwsEc2VpnConnectionDetails$CustomerGatewayConfiguration": "

The configuration information for the VPN connection's customer gateway, in the native XML format.

", "AwsEc2VpnConnectionDetails$Type": "

The type of VPN connection.

", @@ -4965,21 +5101,21 @@ "AwsEc2VpnConnectionVgwTelemetryDetails$CertificateArn": "

The ARN of the VPN tunnel endpoint certificate.

", "AwsEc2VpnConnectionVgwTelemetryDetails$LastStatusChange": "

The date and time of the last change in status.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

", "AwsEc2VpnConnectionVgwTelemetryDetails$OutsideIpAddress": "

The Internet-routable IP address of the virtual private gateway's outside interface.

", - "AwsEc2VpnConnectionVgwTelemetryDetails$Status": "

The status of the VPN tunnel.

", + "AwsEc2VpnConnectionVgwTelemetryDetails$Status": "

The status of the VPN tunnel. Valid values are DOWN or UP.

", "AwsEc2VpnConnectionVgwTelemetryDetails$StatusMessage": "

If an error occurs, a description of the error.

", "AwsEcrContainerImageDetails$RegistryId": "

The Amazon Web Services account identifier that is associated with the registry that the image belongs to.

", "AwsEcrContainerImageDetails$RepositoryName": "

The name of the repository that the image belongs to.

", - "AwsEcrContainerImageDetails$Architecture": "

The architecture of the image.

", + "AwsEcrContainerImageDetails$Architecture": "

The architecture of the image. Valid values are as follows:

", "AwsEcrContainerImageDetails$ImageDigest": "

The sha256 digest of the image manifest.

", "AwsEcrContainerImageDetails$ImagePublishedAt": "

The date and time when the image was pushed to the repository.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

", "AwsEcrRepositoryDetails$Arn": "

The ARN of the repository.

", - "AwsEcrRepositoryDetails$ImageTagMutability": "

The tag mutability setting for the repository.

", + "AwsEcrRepositoryDetails$ImageTagMutability": "

The tag mutability setting for the repository. Valid values are IMMUTABLE or MUTABLE.

", "AwsEcrRepositoryDetails$RepositoryName": "

The name of the repository.

", "AwsEcrRepositoryDetails$RepositoryPolicyText": "

The text of the repository policy.

", "AwsEcrRepositoryLifecyclePolicyDetails$LifecyclePolicyText": "

The text of the lifecycle policy.

", "AwsEcrRepositoryLifecyclePolicyDetails$RegistryId": "

The Amazon Web Services account identifier that is associated with the registry that contains the repository.

", - "AwsEcsClusterClusterSettingsDetails$Name": "

The name of the setting.

", - "AwsEcsClusterClusterSettingsDetails$Value": "

The value of the setting.

", + "AwsEcsClusterClusterSettingsDetails$Name": "

The name of the setting. The valid value is containerInsights.

", + "AwsEcsClusterClusterSettingsDetails$Value": "

The value of the setting. Valid values are disabled or enabled.

", "AwsEcsClusterConfigurationExecuteCommandConfigurationDetails$KmsKeyId": "

The identifier of the KMS key that is used to encrypt the data between the local client and the container.

", "AwsEcsClusterConfigurationExecuteCommandConfigurationDetails$Logging": "

The log setting to use for redirecting logs for run command results.

", "AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails$CloudWatchLogGroupName": "

The name of the CloudWatch log group to send the logs to.

", @@ -5013,7 +5149,7 @@ "AwsEcsServicePlacementStrategiesDetails$Type": "

The type of placement strategy.

The random placement strategy randomly places tasks on available candidates.

The spread placement strategy spreads placement across available candidates evenly based on the value of Field.

The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified in Field.

Valid values: random | spread | binpack

", "AwsEcsServiceServiceRegistriesDetails$ContainerName": "

The container name value to use for the service discovery service.

If the task definition uses the bridge or host network mode, you must specify ContainerName and ContainerPort.

If the task definition uses the awsvpc network mode and a type SRV DNS record, you must specify either ContainerName and ContainerPort, or Port , but not both.

", "AwsEcsServiceServiceRegistriesDetails$RegistryArn": "

The ARN of the service registry.

", - "AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails$Condition": "

The dependency condition of the dependent container. Indicates the required status of the dependent container before the current container can start.

", + "AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails$Condition": "

The dependency condition of the dependent container. Indicates the required status of the dependent container before the current container can start. Valid values are as follows:

", "AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails$ContainerName": "

The name of the dependent container.

", "AwsEcsTaskDefinitionContainerDefinitionsDetails$Hostname": "

The hostname to use for the container.

", "AwsEcsTaskDefinitionContainerDefinitionsDetails$Image": "

The image used to start the container.

", @@ -5022,36 +5158,36 @@ "AwsEcsTaskDefinitionContainerDefinitionsDetails$WorkingDirectory": "

The working directory in which to run commands inside the container.

", "AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails$Name": "

The name of the environment variable.

", "AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails$Value": "

The value of the environment variable.

", - "AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails$Type": "

The type of environment file.

", + "AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails$Type": "

The type of environment file. The valid value is s3.

", "AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails$Value": "

The ARN of the S3 object that contains the environment variable file.

", "AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails$Hostname": "

The hostname to use in the /etc/hosts entry.

", "AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails$IpAddress": "

The IP address to use in the /etc/hosts entry.

", - "AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails$Type": "

The log router to use.

", + "AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails$Type": "

The log router to use. Valid values are fluentbit or fluentd.

", "AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails$ContainerPath": "

The path inside the container at which to expose the host device.

", "AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails$HostPath": "

The path for the device on the host container instance.

", "AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails$ContainerPath": "

The absolute file path where the tmpfs volume is to be mounted.

", - "AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails$LogDriver": "

The log driver to use for the container.

", + "AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails$LogDriver": "

The log driver to use for the container.

Valid values on Fargate are as follows:

Valid values on Amazon EC2 are as follows:

", "AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails$Name": "

The name of the secret.

", "AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails$ValueFrom": "

The secret to expose to the container.

The value is either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Systems Manager Parameter Store.

", "AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails$ContainerPath": "

The path on the container to mount the host volume at.

", "AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails$SourceVolume": "

The name of the volume to mount. Must match the name of a volume listed in VolumeDetails for the task definition.

", "AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails$Protocol": "

The protocol used for the port mapping. The default is tcp.

", "AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails$CredentialsParameter": "

The ARN of the secret that contains the private repository credentials.

", - "AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails$Type": "

The type of resource to assign to a container.

", + "AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails$Type": "

The type of resource to assign to a container. Valid values are GPU or InferenceAccelerator.

", "AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails$Value": "

The value for the specified resource type.

For GPU, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container.

For InferenceAccelerator, the value should match the DeviceName attribute of an entry in InferenceAccelerators.

", "AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails$Name": "

The name of the secret.

", "AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails$ValueFrom": "

The secret to expose to the container. The value is either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Systems Manager Parameter Store.

", "AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails$Namespace": "

The namespaced kernel parameter for which to set a value.

", "AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails$Value": "

The value of the parameter.

", - "AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails$Name": "

The type of the ulimit.

", + "AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails$Name": "

The type of the ulimit. Valid values are as follows:

", "AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails$SourceContainer": "

The name of another container within the same task definition from which to mount volumes.

", - "AwsEcsTaskDefinitionDetails$Cpu": "

The number of CPU units used by the task.

", + "AwsEcsTaskDefinitionDetails$Cpu": "

The number of CPU units used by the task.Valid values are as follows:

", "AwsEcsTaskDefinitionDetails$ExecutionRoleArn": "

The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.

", "AwsEcsTaskDefinitionDetails$Family": "

The name of a family that this task definition is registered to.

", - "AwsEcsTaskDefinitionDetails$IpcMode": "

The IPC resource namespace to use for the containers in the task.

", - "AwsEcsTaskDefinitionDetails$Memory": "

The amount (in MiB) of memory used by the task.

", - "AwsEcsTaskDefinitionDetails$NetworkMode": "

The Docker networking mode to use for the containers in the task.

", - "AwsEcsTaskDefinitionDetails$PidMode": "

The process namespace to use for the containers in the task.

", + "AwsEcsTaskDefinitionDetails$IpcMode": "

The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows:

", + "AwsEcsTaskDefinitionDetails$Memory": "

The amount (in MiB) of memory used by the task.

For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level memory value. For tasks that are hosted on Fargate, you must use one of the specified values in the Amazon Elastic Container Service Developer Guide , which determines your range of supported values for the Cpu and Memory parameters.

", + "AwsEcsTaskDefinitionDetails$NetworkMode": "

The Docker networking mode to use for the containers in the task. Valid values are as follows:

", + "AwsEcsTaskDefinitionDetails$PidMode": "

The process namespace to use for the containers in the task. Valid values are host or task.

", "AwsEcsTaskDefinitionDetails$TaskRoleArn": "

The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.

", "AwsEcsTaskDefinitionInferenceAcceleratorsDetails$DeviceName": "

The Elastic Inference accelerator device name.

", "AwsEcsTaskDefinitionInferenceAcceleratorsDetails$DeviceType": "

The Elastic Inference accelerator type to use.

", @@ -5063,7 +5199,7 @@ "AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails$Value": "

The value of the property.

", "AwsEcsTaskDefinitionVolumesDetails$Name": "

The name of the data volume.

", "AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails$Driver": "

The Docker volume driver to use.

", - "AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails$Scope": "

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are provisioned automatically when the task starts and destroyed when the task stops. Docker volumes that are shared persist after the task stops.

", + "AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails$Scope": "

The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are provisioned automatically when the task starts and destroyed when the task stops. Docker volumes that are shared persist after the task stops. Valid values are shared or task.

", "AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails$AccessPointId": "

The Amazon EFS access point identifier to use.

", "AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails$Iam": "

Whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system.

", "AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails$FilesystemId": "

The Amazon EFS file system identifier to use.

", @@ -5091,7 +5227,7 @@ "AwsEfsAccessPointRootDirectoryDetails$Path": "

Specifies the path on the Amazon EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide CreationInfo.

", "AwsEksClusterDetails$Arn": "

The ARN of the cluster.

", "AwsEksClusterDetails$CertificateAuthorityData": "

The certificate authority data for the cluster.

", - "AwsEksClusterDetails$ClusterStatus": "

The status of the cluster.

", + "AwsEksClusterDetails$ClusterStatus": "

The status of the cluster. Valid values are as follows:

", "AwsEksClusterDetails$Endpoint": "

The endpoint for the Amazon EKS API server.

", "AwsEksClusterDetails$Name": "

The name of the cluster.

", "AwsEksClusterDetails$RoleArn": "

The ARN of the IAM role that provides permissions for the Amazon EKS control plane to make calls to Amazon Web Services API operations on your behalf.

", @@ -5107,7 +5243,7 @@ "AwsElasticBeanstalkEnvironmentDetails$EnvironmentName": "

The name of the environment.

", "AwsElasticBeanstalkEnvironmentDetails$PlatformArn": "

The ARN of the platform version for the environment.

", "AwsElasticBeanstalkEnvironmentDetails$SolutionStackName": "

The name of the solution stack that is deployed with the environment.

", - "AwsElasticBeanstalkEnvironmentDetails$Status": "

The current operational status of the environment.

", + "AwsElasticBeanstalkEnvironmentDetails$Status": "

The current operational status of the environment. Valid values are as follows:

", "AwsElasticBeanstalkEnvironmentDetails$VersionLabel": "

The application version of the environment.

", "AwsElasticBeanstalkEnvironmentEnvironmentLink$EnvironmentName": "

The name of the linked environment.

", "AwsElasticBeanstalkEnvironmentEnvironmentLink$LinkName": "

The name of the environment link.

", @@ -5115,8 +5251,8 @@ "AwsElasticBeanstalkEnvironmentOptionSetting$OptionName": "

The name of the option.

", "AwsElasticBeanstalkEnvironmentOptionSetting$ResourceName": "

The name of the resource.

", "AwsElasticBeanstalkEnvironmentOptionSetting$Value": "

The value of the configuration setting.

", - "AwsElasticBeanstalkEnvironmentTier$Name": "

The name of the environment tier.

", - "AwsElasticBeanstalkEnvironmentTier$Type": "

The type of environment tier.

", + "AwsElasticBeanstalkEnvironmentTier$Name": "

The name of the environment tier. Valid values are WebServer or Worker.

", + "AwsElasticBeanstalkEnvironmentTier$Type": "

The type of environment tier. Valid values are Standard or SQS/HTTP.

", "AwsElasticBeanstalkEnvironmentTier$Version": "

The version of the environment tier.

", "AwsElasticsearchDomainDetails$AccessPolicies": "

IAM policy document specifying the access policies for the new Elasticsearch domain.

", "AwsElasticsearchDomainDetails$DomainId": "

Unique identifier for an Elasticsearch domain.

", @@ -5124,15 +5260,15 @@ "AwsElasticsearchDomainDetails$Endpoint": "

Domain-specific endpoint used to submit index, search, and data upload requests to an Elasticsearch domain.

The endpoint is a service URL.

", "AwsElasticsearchDomainDetails$ElasticsearchVersion": "

OpenSearch version.

", "AwsElasticsearchDomainDomainEndpointOptions$TLSSecurityPolicy": "

The TLS security policy to apply to the HTTPS endpoint of the OpenSearch domain.

Valid values:

", - "AwsElasticsearchDomainElasticsearchClusterConfigDetails$DedicatedMasterType": "

The hardware configuration of the computer that hosts the dedicated master node. For example, m3.medium.elasticsearch. If this attribute is specified, then DedicatedMasterEnabled must be true.

", - "AwsElasticsearchDomainElasticsearchClusterConfigDetails$InstanceType": "

The instance type for your data nodes. For example, m3.medium.elasticsearch.

", + "AwsElasticsearchDomainElasticsearchClusterConfigDetails$DedicatedMasterType": "

The hardware configuration of the computer that hosts the dedicated master node. A sample value is m3.medium.elasticsearch. If this attribute is specified, then DedicatedMasterEnabled must be true.

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

", + "AwsElasticsearchDomainElasticsearchClusterConfigDetails$InstanceType": "

The instance type for your data nodes. For example, m3.medium.elasticsearch.

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

", "AwsElasticsearchDomainEncryptionAtRestOptions$KmsKeyId": "

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

", "AwsElasticsearchDomainLogPublishingOptionsLogConfig$CloudWatchLogsLogGroupArn": "

The ARN of the CloudWatch Logs group to publish the logs to.

", "AwsElasticsearchDomainServiceSoftwareOptions$AutomatedUpdateDate": "

The epoch time when the deployment window closes for required updates. After this time, Amazon OpenSearch Service schedules the software upgrade automatically.

", "AwsElasticsearchDomainServiceSoftwareOptions$CurrentVersion": "

The version of the service software that is currently installed on the domain.

", "AwsElasticsearchDomainServiceSoftwareOptions$Description": "

A more detailed description of the service software status.

", "AwsElasticsearchDomainServiceSoftwareOptions$NewVersion": "

The most recent version of the service software.

", - "AwsElasticsearchDomainServiceSoftwareOptions$UpdateStatus": "

The status of the service software update.

", + "AwsElasticsearchDomainServiceSoftwareOptions$UpdateStatus": "

The status of the service software update. Valid values are as follows:

", "AwsElasticsearchDomainVPCOptions$VPCId": "

ID for the VPC.

", "AwsElbAppCookieStickinessPolicy$CookieName": "

The name of the application cookie used for stickiness.

", "AwsElbAppCookieStickinessPolicy$PolicyName": "

The mnemonic name for the policy being created. The name must be unique within the set of policies for the load balancer.

", @@ -5222,7 +5358,7 @@ "AwsKmsKeyDetails$AWSAccountId": "

The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.

", "AwsKmsKeyDetails$KeyId": "

The globally unique identifier for the KMS key.

", "AwsKmsKeyDetails$KeyManager": "

The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed.

", - "AwsKmsKeyDetails$KeyState": "

The state of the KMS key.

", + "AwsKmsKeyDetails$KeyState": "

The state of the KMS key. Valid values are as follows:

", "AwsKmsKeyDetails$Origin": "

The source of the KMS key material.

When this value is AWS_KMS, KMS created the key material.

When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the KMS key lacks key material.

When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.

", "AwsKmsKeyDetails$Description": "

A description of the KMS key.

", "AwsLambdaFunctionCode$S3Bucket": "

An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.

", @@ -5264,7 +5400,7 @@ "AwsNetworkFirewallRuleGroupDetails$RuleGroupId": "

The identifier of the rule group.

", "AwsNetworkFirewallRuleGroupDetails$RuleGroupName": "

The descriptive name of the rule group.

", "AwsNetworkFirewallRuleGroupDetails$Type": "

The type of rule group. A rule group can be stateful or stateless.

", - "AwsOpenSearchServiceDomainClusterConfigDetails$InstanceType": "

The instance type for your data nodes.

", + "AwsOpenSearchServiceDomainClusterConfigDetails$InstanceType": "

The instance type for your data nodes.

For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.

", "AwsOpenSearchServiceDomainClusterConfigDetails$WarmType": "

The type of UltraWarm instance.

", "AwsOpenSearchServiceDomainClusterConfigDetails$DedicatedMasterType": "

The hardware configuration of the computer that hosts the dedicated master node.

If this attribute is specified, then DedicatedMasterEnabled must be true.

", "AwsOpenSearchServiceDomainDetails$Arn": "

The ARN of the OpenSearch Service domain.

", @@ -5285,14 +5421,14 @@ "AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails$CurrentVersion": "

The version of the service software that is currently installed on the domain.

", "AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails$Description": "

A more detailed description of the service software status.

", "AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails$NewVersion": "

The most recent version of the service software.

", - "AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails$UpdateStatus": "

The status of the service software update.

", + "AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails$UpdateStatus": "

The status of the service software update. Valid values are as follows:

", "AwsRdsDbClusterAssociatedRole$RoleArn": "

The ARN of the IAM role.

", - "AwsRdsDbClusterAssociatedRole$Status": "

The status of the association between the IAM role and the DB cluster.

", + "AwsRdsDbClusterAssociatedRole$Status": "

The status of the association between the IAM role and the DB cluster. Valid values are as follows:

", "AwsRdsDbClusterDetails$DatabaseName": "

The name of the database.

", "AwsRdsDbClusterDetails$Status": "

The current status of this DB cluster.

", "AwsRdsDbClusterDetails$Endpoint": "

The connection endpoint for the primary instance of the DB cluster.

", "AwsRdsDbClusterDetails$ReaderEndpoint": "

The reader endpoint for the DB cluster.

", - "AwsRdsDbClusterDetails$Engine": "

The name of the database engine to use for this DB cluster.

", + "AwsRdsDbClusterDetails$Engine": "

The name of the database engine to use for this DB cluster. Valid values are as follows:

", "AwsRdsDbClusterDetails$EngineVersion": "

The version number of the database engine to use.

", "AwsRdsDbClusterDetails$MasterUsername": "

The name of the master user for the DB cluster.

", "AwsRdsDbClusterDetails$PreferredBackupWindow": "

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

", @@ -5301,8 +5437,8 @@ "AwsRdsDbClusterDetails$KmsKeyId": "

The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.

", "AwsRdsDbClusterDetails$DbClusterResourceId": "

The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.

", "AwsRdsDbClusterDetails$ClusterCreateTime": "

Indicates when the DB cluster was created, in Universal Coordinated Time (UTC).

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

", - "AwsRdsDbClusterDetails$EngineMode": "

The database engine mode of the DB cluster.

", - "AwsRdsDbClusterDetails$ActivityStreamStatus": "

The status of the database activity stream.

", + "AwsRdsDbClusterDetails$EngineMode": "

The database engine mode of the DB cluster.Valid values are as follows:

", + "AwsRdsDbClusterDetails$ActivityStreamStatus": "

The status of the database activity stream. Valid values are as follows:

", "AwsRdsDbClusterDetails$DbClusterParameterGroup": "

The name of the DB cluster parameter group for the DB cluster.

", "AwsRdsDbClusterDetails$DbSubnetGroup": "

The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.

", "AwsRdsDbClusterDetails$DbClusterIdentifier": "

The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.

", @@ -5371,7 +5507,7 @@ "AwsRdsDbPendingModifiedValues$StorageType": "

The new storage type for the DB instance.

", "AwsRdsDbPendingModifiedValues$CaCertificateIdentifier": "

The new CA certificate identifier for the DB instance.

", "AwsRdsDbPendingModifiedValues$DbSubnetGroupName": "

The name of the new subnet group for the DB instance.

", - "AwsRdsDbProcessorFeature$Name": "

The name of the processor feature.

", + "AwsRdsDbProcessorFeature$Name": "

The name of the processor feature. Valid values are coreCount or threadsPerCore.

", "AwsRdsDbProcessorFeature$Value": "

The value of the processor feature.

", "AwsRdsDbSecurityGroupDetails$DbSecurityGroupArn": "

The ARN for the DB security group.

", "AwsRdsDbSecurityGroupDetails$DbSecurityGroupDescription": "

Provides the description of the DB security group.

", @@ -5387,7 +5523,7 @@ "AwsRdsDbSnapshotDetails$DbSnapshotIdentifier": "

The name or ARN of the DB snapshot that is used to restore the DB instance.

", "AwsRdsDbSnapshotDetails$DbInstanceIdentifier": "

A name for the DB instance.

", "AwsRdsDbSnapshotDetails$SnapshotCreateTime": "

When the snapshot was taken in Coordinated Universal Time (UTC).

", - "AwsRdsDbSnapshotDetails$Engine": "

The name of the database engine to use for this DB instance.

", + "AwsRdsDbSnapshotDetails$Engine": "

The name of the database engine to use for this DB instance. Valid values are as follows:

", "AwsRdsDbSnapshotDetails$Status": "

The status of this DB snapshot.

", "AwsRdsDbSnapshotDetails$AvailabilityZone": "

Specifies the name of the Availability Zone in which the DB instance was located at the time of the DB snapshot.

", "AwsRdsDbSnapshotDetails$VpcId": "

The VPC ID associated with the DB snapshot.

", @@ -5399,7 +5535,7 @@ "AwsRdsDbSnapshotDetails$OptionGroupName": "

The option group name for the DB snapshot.

", "AwsRdsDbSnapshotDetails$SourceRegion": "

The Amazon Web Services Region that the DB snapshot was created in or copied from.

", "AwsRdsDbSnapshotDetails$SourceDbSnapshotIdentifier": "

The DB snapshot ARN that the DB snapshot was copied from.

", - "AwsRdsDbSnapshotDetails$StorageType": "

The storage type associated with the DB snapshot.

", + "AwsRdsDbSnapshotDetails$StorageType": "

The storage type associated with the DB snapshot. Valid values are as follows:

", "AwsRdsDbSnapshotDetails$TdeCredentialArn": "

The ARN from the key store with which to associate the instance for TDE encryption.

", "AwsRdsDbSnapshotDetails$KmsKeyId": "

If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.

", "AwsRdsDbSnapshotDetails$Timezone": "

The time zone of the DB snapshot.

", @@ -5488,17 +5624,17 @@ "AwsS3BucketBucketLifecycleConfigurationRulesDetails$Prefix": "

A prefix that identifies one or more objects that the rule applies to.

", "AwsS3BucketBucketLifecycleConfigurationRulesDetails$Status": "

The current status of the rule. Indicates whether the rule is currently being applied.

", "AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails$Prefix": "

A prefix filter.

", - "AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails$Type": "

Whether to use AND or OR to join the operands.

", + "AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails$Type": "

Whether to use AND or OR to join the operands. Valid values are LifecycleAndOperator or LifecycleOrOperator.

", "AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails$Prefix": "

Prefix text for matching objects.

", - "AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails$Type": "

The type of filter value.

", + "AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails$Type": "

The type of filter value. Valid values are LifecyclePrefixPredicate or LifecycleTagPredicate.

", "AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails$Key": "

The tag key.

", "AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails$Value": "

The tag value.

", "AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails$Key": "

The tag key.

", "AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails$Value": "

The tag value

", "AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails$StorageClass": "

The class of storage to change the object to after the object is noncurrent for the specified number of days.

", "AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails$Date": "

A date on which to transition objects to the specified storage class. If you provide Date, you cannot provide Days.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

", - "AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails$StorageClass": "

The storage class to transition the object to.

", - "AwsS3BucketBucketVersioningConfiguration$Status": "

The versioning status of the S3 bucket.

", + "AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails$StorageClass": "

The storage class to transition the object to. Valid values are as follows:

", + "AwsS3BucketBucketVersioningConfiguration$Status": "

The versioning status of the S3 bucket. Valid values are Enabled or Suspended.

", "AwsS3BucketDetails$OwnerId": "

The canonical user ID of the owner of the S3 bucket.

", "AwsS3BucketDetails$OwnerName": "

The display name of the owner of the S3 bucket.

", "AwsS3BucketDetails$OwnerAccountId": "

The Amazon Web Services account identifier of the account that owns the S3 bucket.

", @@ -5507,15 +5643,15 @@ "AwsS3BucketLoggingConfiguration$DestinationBucketName": "

The name of the S3 bucket where log files for the S3 bucket are stored.

", "AwsS3BucketLoggingConfiguration$LogFilePrefix": "

The prefix added to log files for the S3 bucket.

", "AwsS3BucketNotificationConfigurationDetail$Destination": "

The ARN of the Lambda function, Amazon SQS queue, or Amazon SNS topic that generates the notification.

", - "AwsS3BucketNotificationConfigurationDetail$Type": "

Indicates the type of notification. Notifications can be generated using Lambda functions, Amazon SQS queues or Amazon SNS topics.

", + "AwsS3BucketNotificationConfigurationDetail$Type": "

Indicates the type of notification. Notifications can be generated using Lambda functions, Amazon SQS queues, or Amazon SNS topics, with corresponding valid values as follows:

", "AwsS3BucketNotificationConfigurationEvents$member": null, "AwsS3BucketNotificationConfigurationS3KeyFilterRule$Value": "

The filter value.

", - "AwsS3BucketServerSideEncryptionByDefault$SSEAlgorithm": "

Server-side encryption algorithm to use for the default encryption.

", + "AwsS3BucketServerSideEncryptionByDefault$SSEAlgorithm": "

Server-side encryption algorithm to use for the default encryption. Valid values are aws: kms or AES256.

", "AwsS3BucketServerSideEncryptionByDefault$KMSMasterKeyID": "

KMS key ID to use for the default encryption.

", "AwsS3BucketWebsiteConfiguration$ErrorDocument": "

The name of the error document for the website.

", "AwsS3BucketWebsiteConfiguration$IndexDocumentSuffix": "

The name of the index document for the website.

", "AwsS3BucketWebsiteConfigurationRedirectTo$Hostname": "

The name of the host to redirect requests to.

", - "AwsS3BucketWebsiteConfigurationRedirectTo$Protocol": "

The protocol to use when redirecting requests. By default, uses the same protocol as the original request.

", + "AwsS3BucketWebsiteConfigurationRedirectTo$Protocol": "

The protocol to use when redirecting requests. By default, this field uses the same protocol as the original request. Valid values are http or https.

", "AwsS3BucketWebsiteConfigurationRoutingRuleCondition$HttpErrorCodeReturnedEquals": "

Indicates to redirect the request if the HTTP error code matches this value.

", "AwsS3BucketWebsiteConfigurationRoutingRuleCondition$KeyPrefixEquals": "

Indicates to redirect the request if the key prefix matches this value.

", "AwsS3BucketWebsiteConfigurationRoutingRuleRedirect$Hostname": "

The host name to use in the redirect request.

", @@ -5565,24 +5701,24 @@ "AwsSqsQueueDetails$KmsMasterKeyId": "

The ID of an Amazon Web Services managed key for Amazon SQS or a custom KMS key.

", "AwsSqsQueueDetails$QueueName": "

The name of the new queue.

", "AwsSqsQueueDetails$DeadLetterTargetArn": "

The ARN of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

", - "AwsSsmComplianceSummary$Status": "

The current patch compliance status.

The possible status values are:

", + "AwsSsmComplianceSummary$Status": "

The current patch compliance status. Valid values are as follows:

", "AwsSsmComplianceSummary$ExecutionType": "

The type of execution that was used determine compliance.

", "AwsSsmComplianceSummary$ComplianceType": "

The type of resource for which the compliance was determined. For AwsSsmPatchCompliance, ComplianceType is Patch.

", "AwsSsmComplianceSummary$PatchBaselineId": "

The identifier of the patch baseline. The patch baseline lists the patches that are approved for installation.

", - "AwsSsmComplianceSummary$OverallSeverity": "

The highest severity for the patches.

", + "AwsSsmComplianceSummary$OverallSeverity": "

The highest severity for the patches. Valid values are as follows:

", "AwsSsmComplianceSummary$PatchGroup": "

The identifier of the patch group for which compliance was determined. A patch group uses tags to group EC2 instances that should have the same patch compliance.

", "AwsWafRateBasedRuleDetails$MetricName": "

The name of the metrics for the rate-based rule.

", "AwsWafRateBasedRuleDetails$Name": "

The name of the rate-based rule.

", "AwsWafRateBasedRuleDetails$RateKey": "

The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

", "AwsWafRateBasedRuleDetails$RuleId": "

The unique identifier for the rate-based rule.

", "AwsWafRateBasedRuleMatchPredicate$DataId": "

The unique identifier for the predicate.

", - "AwsWafRateBasedRuleMatchPredicate$Type": "

The type of predicate.

", + "AwsWafRateBasedRuleMatchPredicate$Type": "

The type of predicate. Valid values are as follows:

", "AwsWafRegionalRateBasedRuleDetails$MetricName": "

The name of the metrics for the rate-based rule.

", "AwsWafRegionalRateBasedRuleDetails$Name": "

The name of the rate-based rule.

", "AwsWafRegionalRateBasedRuleDetails$RateKey": "

The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

", "AwsWafRegionalRateBasedRuleDetails$RuleId": "

The unique identifier for the rate-based rule.

", "AwsWafRegionalRateBasedRuleMatchPredicate$DataId": "

The unique identifier for the predicate.

", - "AwsWafRegionalRateBasedRuleMatchPredicate$Type": "

The type of predicate.

", + "AwsWafRegionalRateBasedRuleMatchPredicate$Type": "

The type of predicate. Valid values are as follows:

", "AwsWafRegionalRuleDetails$MetricName": "

A name for the metrics for the rule.

", "AwsWafRegionalRuleDetails$Name": "

A descriptive name for the rule.

", "AwsWafRegionalRuleDetails$RuleId": "

The ID of the rule.

", @@ -5619,9 +5755,9 @@ "AwsWafWebAclRule$RuleId": "

The identifier for a rule.

", "AwsWafWebAclRule$Type": "

The rule type.

Valid values: REGULAR | RATE_BASED | GROUP

The default is REGULAR.

", "AwsXrayEncryptionConfigDetails$KeyId": "

The identifier of the KMS key that is used for encryption. Provided if Type is KMS.

", - "AwsXrayEncryptionConfigDetails$Status": "

The current status of the encryption configuration. When Status is UPDATING, X-Ray might use both the old and new encryption.

", - "AwsXrayEncryptionConfigDetails$Type": "

The type of encryption. KMS indicates that the encryption uses KMS keys. NONE indicates to use the default encryption.

", - "BatchUpdateFindingsUnprocessedFinding$ErrorCode": "

The code associated with the error. Possible values are:

", + "AwsXrayEncryptionConfigDetails$Status": "

The current status of the encryption configuration. Valid values are ACTIVE or UPDATING.

When Status is equal to UPDATING, X-Ray might use both the old and new encryption.

", + "AwsXrayEncryptionConfigDetails$Type": "

The type of encryption. KMS indicates that the encryption uses KMS keys. NONE indicates the default encryption.

", + "BatchUpdateFindingsUnprocessedFinding$ErrorCode": "

The code associated with the error. Possible values are:

", "BatchUpdateFindingsUnprocessedFinding$ErrorMessage": "

The message associated with the error. Possible values are:

", "CategoryList$member": null, "Cell$ColumnName": "

The name of the column that contains the data.

", @@ -5715,7 +5851,7 @@ "IpOrganizationDetails$Org": "

The name of the internet provider.

", "Ipv6CidrBlockAssociation$AssociationId": "

The association ID for the IPv6 CIDR block.

", "Ipv6CidrBlockAssociation$Ipv6CidrBlock": "

The IPv6 CIDR block.

", - "Ipv6CidrBlockAssociation$CidrBlockState": "

Information about the state of the CIDR block.

", + "Ipv6CidrBlockAssociation$CidrBlockState": "

Information about the state of the CIDR block. Valid values are as follows:

", "KeywordFilter$Value": "

A value for the keyword.

", "LimitExceededException$Message": null, "LimitExceededException$Code": null, @@ -5807,6 +5943,8 @@ "SoftwarePackage$Architecture": "

The architecture used for the software package.

", "SoftwarePackage$PackageManager": "

The source of the package.

", "SoftwarePackage$FilePath": "

The file system path to the package manager inventory file.

", + "SoftwarePackage$FixedInVersion": "

The version of the software package in which the vulnerability has been resolved.

", + "SoftwarePackage$Remediation": "

Describes the actions a customer can take to resolve the vulnerability in the software package.

", "SortCriterion$Field": "

The finding attribute used to sort findings.

", "Standard$StandardsArn": "

The ARN of a standard.

", "Standard$Name": "

The name of the standard.

", @@ -5870,6 +6008,7 @@ "AwsApiGatewayRestApiDetails$BinaryMediaTypes": "

The list of binary media types supported by the REST API.

", "AwsAutoScalingLaunchConfigurationDetails$ClassicLinkVpcSecurityGroups": "

The identifiers of one or more security groups for the VPC that is specified in ClassicLinkVPCId.

", "AwsAutoScalingLaunchConfigurationDetails$SecurityGroups": "

The security groups to assign to the instances in the Auto Scaling group.

", + "AwsBackupBackupVaultNotificationsDetails$BackupVaultEvents": "

An array of events that indicate the status of jobs to back up resources to the backup vault. The following events are supported:

", "AwsCloudFormationStackDetails$Capabilities": "

The capabilities allowed in the stack.

", "AwsCloudFormationStackDetails$NotificationArns": "

The Amazon Resource Names (ARNs) of the Amazon SNS topic to which stack-related events are published.

", "AwsCloudFrontDistributionOriginSslProtocols$Items": "

A list that contains allowed SSL/TLS protocols for this distribution.

", @@ -5903,13 +6042,13 @@ "AwsEcsTaskDefinitionContainerDefinitionsDetails$EntryPoint": "

The entry point that is passed to the container.

", "AwsEcsTaskDefinitionContainerDefinitionsDetails$Links": "

A list of links for the container in the form container_name:alias . Allows containers to communicate with each other without the need for port mappings.

", "AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails$Command": "

The command that the container runs to determine whether it is healthy.

", - "AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails$Add": "

The Linux capabilities for the container that are added to the default configuration provided by Docker.

", - "AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails$Drop": "

The Linux capabilities for the container that are dropped from the default configuration provided by Docker.

", + "AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails$Add": "

The Linux capabilities for the container that are added to the default configuration provided by Docker. Valid values are as follows:

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"

", + "AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails$Drop": "

The Linux capabilities for the container that are dropped from the default configuration provided by Docker.

Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" | \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" | \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" | \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\" | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" | \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" | \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" | \"WAKE_ALARM\"

", "AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails$Permissions": "

The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.

", - "AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails$MountOptions": "

The list of tmpfs volume mount options.

", + "AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails$MountOptions": "

The list of tmpfs volume mount options.

Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"

", "AwsEcsTaskDefinitionDetails$RequiresCompatibilities": "

The task launch types that the task definition was validated against.

", "AwsEfsAccessPointPosixUserDetails$SecondaryGids": "

Secondary POSIX group IDs used for all file system operations using this access point.

", - "AwsEksClusterLoggingClusterLoggingDetails$Types": "

A list of logging types.

", + "AwsEksClusterLoggingClusterLoggingDetails$Types": "

A list of logging types. Valid values are as follows:

", "AwsEksClusterResourcesVpcConfigDetails$SecurityGroupIds": "

The security groups that are associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Amazon EKS control plane.

", "AwsEksClusterResourcesVpcConfigDetails$SubnetIds": "

The subnets that are associated with the cluster.

", "AwsElasticsearchDomainVPCOptions$AvailabilityZones": "

The list of Availability Zones associated with the VPC subnets.

", @@ -6924,6 +7063,12 @@ "VulnerabilityList$member": null } }, + "VulnerabilityFixAvailable": { + "base": null, + "refs": { + "Vulnerability$FixAvailable": "

Specifies if all vulnerable packages in a finding have a value for FixedInVersion and Remediation. This field is evaluated for each vulnerability Id based on the number of vulnerable packages that have a value for both FixedInVersion and Remediation. Valid values are as follows:

" + } + }, "VulnerabilityList": { "base": null, "refs": { diff --git a/models/apis/support-app/2021-08-20/api-2.json b/models/apis/support-app/2021-08-20/api-2.json new file mode 100644 index 0000000000..3c123a8807 --- /dev/null +++ b/models/apis/support-app/2021-08-20/api-2.json @@ -0,0 +1,445 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-08-20", + "endpointPrefix":"supportapp", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"SupportApp", + "serviceFullName":"AWS Support App", + "serviceId":"Support App", + "signatureVersion":"v4", + "signingName":"supportapp", + "uid":"support-app-2021-08-20" + }, + "operations":{ + "CreateSlackChannelConfiguration":{ + "name":"CreateSlackChannelConfiguration", + "http":{ + "method":"POST", + "requestUri":"/control/create-slack-channel-configuration", + "responseCode":200 + }, + "input":{"shape":"CreateSlackChannelConfigurationRequest"}, + "output":{"shape":"CreateSlackChannelConfigurationResult"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ] + }, + "DeleteAccountAlias":{ + "name":"DeleteAccountAlias", + "http":{ + "method":"POST", + "requestUri":"/control/delete-account-alias", + "responseCode":200 + }, + "input":{"shape":"DeleteAccountAliasRequest"}, + "output":{"shape":"DeleteAccountAliasResult"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, + "DeleteSlackChannelConfiguration":{ + "name":"DeleteSlackChannelConfiguration", + "http":{ + "method":"POST", + "requestUri":"/control/delete-slack-channel-configuration", + "responseCode":200 + }, + "input":{"shape":"DeleteSlackChannelConfigurationRequest"}, + "output":{"shape":"DeleteSlackChannelConfigurationResult"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ] + }, + "DeleteSlackWorkspaceConfiguration":{ + "name":"DeleteSlackWorkspaceConfiguration", + "http":{ + "method":"POST", + "requestUri":"/control/delete-slack-workspace-configuration", + "responseCode":200 + }, + "input":{"shape":"DeleteSlackWorkspaceConfigurationRequest"}, + "output":{"shape":"DeleteSlackWorkspaceConfigurationResult"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ] + }, + "GetAccountAlias":{ + "name":"GetAccountAlias", + "http":{ + "method":"POST", + "requestUri":"/control/get-account-alias", + "responseCode":200 + }, + "input":{"shape":"GetAccountAliasRequest"}, + "output":{"shape":"GetAccountAliasResult"}, + "errors":[ + {"shape":"InternalServerException"} + ] + }, + "ListSlackChannelConfigurations":{ + "name":"ListSlackChannelConfigurations", + "http":{ + "method":"POST", + "requestUri":"/control/list-slack-channel-configurations", + "responseCode":200 + }, + "input":{"shape":"ListSlackChannelConfigurationsRequest"}, + "output":{"shape":"ListSlackChannelConfigurationsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, + "ListSlackWorkspaceConfigurations":{ + "name":"ListSlackWorkspaceConfigurations", + "http":{ + "method":"POST", + "requestUri":"/control/list-slack-workspace-configurations", + "responseCode":200 + }, + "input":{"shape":"ListSlackWorkspaceConfigurationsRequest"}, + "output":{"shape":"ListSlackWorkspaceConfigurationsResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"} + ] + }, + "PutAccountAlias":{ + "name":"PutAccountAlias", + "http":{ + "method":"POST", + "requestUri":"/control/put-account-alias", + "responseCode":200 + }, + "input":{"shape":"PutAccountAliasRequest"}, + "output":{"shape":"PutAccountAliasResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ] + }, + "UpdateSlackChannelConfiguration":{ + "name":"UpdateSlackChannelConfiguration", + "http":{ + "method":"POST", + "requestUri":"/control/update-slack-channel-configuration", + "responseCode":200 + }, + "input":{"shape":"UpdateSlackChannelConfigurationRequest"}, + "output":{"shape":"UpdateSlackChannelConfigurationResult"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ValidationException"} + ] + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "CreateSlackChannelConfigurationRequest":{ + "type":"structure", + "required":[ + "channelId", + "channelRoleArn", + "notifyOnCaseSeverity", + "teamId" + ], + "members":{ + "channelId":{"shape":"channelId"}, + "channelName":{"shape":"channelName"}, + "channelRoleArn":{"shape":"roleArn"}, + "notifyOnAddCorrespondenceToCase":{"shape":"booleanValue"}, + "notifyOnCaseSeverity":{"shape":"NotificationSeverityLevel"}, + "notifyOnCreateOrReopenCase":{"shape":"booleanValue"}, + "notifyOnResolveCase":{"shape":"booleanValue"}, + "teamId":{"shape":"teamId"} + } + }, + "CreateSlackChannelConfigurationResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteAccountAliasRequest":{ + "type":"structure", + "members":{ + } + }, + "DeleteAccountAliasResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteSlackChannelConfigurationRequest":{ + "type":"structure", + "required":[ + "channelId", + "teamId" + ], + "members":{ + "channelId":{"shape":"channelId"}, + "teamId":{"shape":"teamId"} + } + }, + "DeleteSlackChannelConfigurationResult":{ + "type":"structure", + "members":{ + } + }, + "DeleteSlackWorkspaceConfigurationRequest":{ + "type":"structure", + "required":["teamId"], + "members":{ + "teamId":{"shape":"teamId"} + } + }, + "DeleteSlackWorkspaceConfigurationResult":{ + "type":"structure", + "members":{ + } + }, + "GetAccountAliasRequest":{ + "type":"structure", + "members":{ + } + }, + "GetAccountAliasResult":{ + "type":"structure", + "members":{ + "accountAlias":{"shape":"awsAccountAlias"} + } + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "ListSlackChannelConfigurationsRequest":{ + "type":"structure", + "members":{ + "nextToken":{"shape":"paginationToken"} + } + }, + "ListSlackChannelConfigurationsResult":{ + "type":"structure", + "required":["slackChannelConfigurations"], + "members":{ + "nextToken":{"shape":"paginationToken"}, + "slackChannelConfigurations":{"shape":"slackChannelConfigurationList"} + } + }, + "ListSlackWorkspaceConfigurationsRequest":{ + "type":"structure", + "members":{ + "nextToken":{"shape":"paginationToken"} + } + }, + "ListSlackWorkspaceConfigurationsResult":{ + "type":"structure", + "members":{ + "nextToken":{"shape":"paginationToken"}, + "slackWorkspaceConfigurations":{"shape":"SlackWorkspaceConfigurationList"} + } + }, + "NotificationSeverityLevel":{ + "type":"string", + "enum":[ + "none", + "all", + "high" + ] + }, + "PutAccountAliasRequest":{ + "type":"structure", + "required":["accountAlias"], + "members":{ + "accountAlias":{"shape":"awsAccountAlias"} + } + }, + "PutAccountAliasResult":{ + "type":"structure", + "members":{ + } + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SlackChannelConfiguration":{ + "type":"structure", + "required":[ + "channelId", + "teamId" + ], + "members":{ + "channelId":{"shape":"channelId"}, + "channelName":{"shape":"channelName"}, + "channelRoleArn":{"shape":"roleArn"}, + "notifyOnAddCorrespondenceToCase":{"shape":"booleanValue"}, + "notifyOnCaseSeverity":{"shape":"NotificationSeverityLevel"}, + "notifyOnCreateOrReopenCase":{"shape":"booleanValue"}, + "notifyOnResolveCase":{"shape":"booleanValue"}, + "teamId":{"shape":"teamId"} + } + }, + "SlackWorkspaceConfiguration":{ + "type":"structure", + "required":["teamId"], + "members":{ + "teamId":{"shape":"teamId"} + } + }, + "SlackWorkspaceConfigurationList":{ + "type":"list", + "member":{"shape":"SlackWorkspaceConfiguration"} + }, + "UpdateSlackChannelConfigurationRequest":{ + "type":"structure", + "required":[ + "channelId", + "teamId" + ], + "members":{ + "channelId":{"shape":"channelId"}, + "channelName":{"shape":"channelName"}, + "channelRoleArn":{"shape":"roleArn"}, + "notifyOnAddCorrespondenceToCase":{"shape":"booleanValue"}, + "notifyOnCaseSeverity":{"shape":"NotificationSeverityLevel"}, + "notifyOnCreateOrReopenCase":{"shape":"booleanValue"}, + "notifyOnResolveCase":{"shape":"booleanValue"}, + "teamId":{"shape":"teamId"} + } + }, + "UpdateSlackChannelConfigurationResult":{ + "type":"structure", + "members":{ + "channelId":{"shape":"channelId"}, + "channelName":{"shape":"channelName"}, + "channelRoleArn":{"shape":"roleArn"}, + "notifyOnAddCorrespondenceToCase":{"shape":"booleanValue"}, + "notifyOnCaseSeverity":{"shape":"NotificationSeverityLevel"}, + "notifyOnCreateOrReopenCase":{"shape":"booleanValue"}, + "notifyOnResolveCase":{"shape":"booleanValue"}, + "teamId":{"shape":"teamId"} + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"errorMessage"} + }, + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "awsAccountAlias":{ + "type":"string", + "max":30, + "min":1, + "pattern":"^[\\w\\- ]+$" + }, + "booleanValue":{ + "type":"boolean", + "box":true + }, + "channelId":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^\\S+$" + }, + "channelName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^.+$" + }, + "errorMessage":{"type":"string"}, + "paginationToken":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^\\S+$" + }, + "roleArn":{ + "type":"string", + "max":2048, + "min":31, + "pattern":"^arn:aws:iam::[0-9]{12}:role/(.+)$" + }, + "slackChannelConfigurationList":{ + "type":"list", + "member":{"shape":"SlackChannelConfiguration"} + }, + "teamId":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^\\S+$" + } + } +} diff --git a/models/apis/support-app/2021-08-20/docs-2.json b/models/apis/support-app/2021-08-20/docs-2.json new file mode 100644 index 0000000000..4d689e7e1a --- /dev/null +++ b/models/apis/support-app/2021-08-20/docs-2.json @@ -0,0 +1,254 @@ +{ + "version": "2.0", + "service": "

Amazon Web Services Support App in Slack

You can use the Amazon Web Services Support App in Slack API to manage your support cases in Slack for your Amazon Web Services account. After you configure your Slack workspace and channel with the Amazon Web Services Support App, you can perform the following tasks directly in your Slack channel:

For more information about how to perform these actions in Slack, see the following documentation in the Amazon Web Services Support User Guide:

You can also use the Amazon Web Services Management Console instead of the Amazon Web Services Support App API to manage your Slack configurations. For more information, see Authorize a Slack workspace to enable the Amazon Web Services Support App.

 <note> <ul> <li> <p>You must have a Business or Enterprise Support plan to use the Amazon Web Services Support App API. </p> </li> <li> <p>For more information about the Amazon Web Services Support App endpoints, see the <a href="https://docs.aws.amazon.com/general/latest/gr/awssupport.html#awssupport_app_region">Amazon Web Services Support App in Slack endpoints</a> in the <i>Amazon Web Services General Reference</i>.</p> </li> </ul> </note>
", + "operations": { + "CreateSlackChannelConfiguration": "

Creates a Slack channel configuration for your Amazon Web Services account.

A Slack channel can have up to 100 Amazon Web Services accounts. This means that only 100 accounts can add the same Slack channel to the Amazon Web Services Support App. We recommend that you only add the accounts that you need to manage support cases for your organization. This can reduce the notifications about case updates that you receive in the Slack channel.

We recommend that you choose a private Slack channel so that only members in that channel have read and write access to your support cases. Anyone in your Slack channel can create, update, or resolve support cases for your account. Users require an invitation to join private channels.

", + "DeleteAccountAlias": "

Deletes an alias for an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

", + "DeleteSlackChannelConfiguration": "

Deletes a Slack channel configuration from your Amazon Web Services account. This operation doesn't delete your Slack channel.

", + "DeleteSlackWorkspaceConfiguration": "

Deletes a Slack workspace configuration from your Amazon Web Services account. This operation doesn't delete your Slack workspace.

", + "GetAccountAlias": "

Retrieves the alias from an Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

", + "ListSlackChannelConfigurations": "

Lists the Slack channel configurations for an Amazon Web Services account.

", + "ListSlackWorkspaceConfigurations": "

Lists the Slack workspace configurations for an Amazon Web Services account.

", + "PutAccountAlias": "

Creates or updates an individual alias for each Amazon Web Services account ID. The alias appears in the Amazon Web Services Support App page of the Amazon Web Services Support Center. The alias also appears in Slack messages from the Amazon Web Services Support App.

", + "UpdateSlackChannelConfiguration": "

Updates the configuration for a Slack channel, such as case update notifications.

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

You don't have sufficient permission to perform this action.

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

Your request has a conflict. For example, you might receive this error if you try the following:

", + "refs": { + } + }, + "CreateSlackChannelConfigurationRequest": { + "base": null, + "refs": { + } + }, + "CreateSlackChannelConfigurationResult": { + "base": null, + "refs": { + } + }, + "DeleteAccountAliasRequest": { + "base": null, + "refs": { + } + }, + "DeleteAccountAliasResult": { + "base": null, + "refs": { + } + }, + "DeleteSlackChannelConfigurationRequest": { + "base": null, + "refs": { + } + }, + "DeleteSlackChannelConfigurationResult": { + "base": null, + "refs": { + } + }, + "DeleteSlackWorkspaceConfigurationRequest": { + "base": null, + "refs": { + } + }, + "DeleteSlackWorkspaceConfigurationResult": { + "base": null, + "refs": { + } + }, + "GetAccountAliasRequest": { + "base": null, + "refs": { + } + }, + "GetAccountAliasResult": { + "base": null, + "refs": { + } + }, + "InternalServerException": { + "base": "

We can’t process your request right now because of a server issue. Try again later.

", + "refs": { + } + }, + "ListSlackChannelConfigurationsRequest": { + "base": null, + "refs": { + } + }, + "ListSlackChannelConfigurationsResult": { + "base": null, + "refs": { + } + }, + "ListSlackWorkspaceConfigurationsRequest": { + "base": null, + "refs": { + } + }, + "ListSlackWorkspaceConfigurationsResult": { + "base": null, + "refs": { + } + }, + "NotificationSeverityLevel": { + "base": null, + "refs": { + "CreateSlackChannelConfigurationRequest$notifyOnCaseSeverity": "

The case severity for a support case that you want to receive notifications.

 <p>If you specify <code>high</code> or <code>all</code>, you must specify <code>true</code> for at least one of the following parameters:</p> <ul> <li> <p> <code>notifyOnAddCorrespondenceToCase</code> </p> </li> <li> <p> <code>notifyOnCreateOrReopenCase</code> </p> </li> <li> <p> <code>notifyOnResolveCase</code> </p> </li> </ul> <p>If you specify <code>none</code>, the following parameters must be null or <code>false</code>:</p> <ul> <li> <p> <code>notifyOnAddCorrespondenceToCase</code> </p> </li> <li> <p> <code>notifyOnCreateOrReopenCase</code> </p> </li> <li> <p> <code>notifyOnResolveCase</code> </p> </li> </ul> <note> <p>If you don't specify these parameters in your request, they default to <code>false</code>.</p> </note>
", + "SlackChannelConfiguration$notifyOnCaseSeverity": "

The case severity for a support case that you want to receive notifications.

", + "UpdateSlackChannelConfigurationRequest$notifyOnCaseSeverity": "

The case severity for a support case that you want to receive notifications.

 <p>If you specify <code>high</code> or <code>all</code>, at least one of the following parameters must be <code>true</code>:</p> <ul> <li> <p> <code>notifyOnAddCorrespondenceToCase</code> </p> </li> <li> <p> <code>notifyOnCreateOrReopenCase</code> </p> </li> <li> <p> <code>notifyOnResolveCase</code> </p> </li> </ul> <p>If you specify <code>none</code>, any of the following parameters that you specify in your request must be <code>false</code>:</p> <ul> <li> <p> <code>notifyOnAddCorrespondenceToCase</code> </p> </li> <li> <p> <code>notifyOnCreateOrReopenCase</code> </p> </li> <li> <p> <code>notifyOnResolveCase</code> </p> </li> </ul> <note> <p>If you don't specify these parameters in your request, the Amazon Web Services Support App uses the current values by default.</p> </note>
", + "UpdateSlackChannelConfigurationResult$notifyOnCaseSeverity": "

The case severity for a support case that you want to receive notifications.

" + } + }, + "PutAccountAliasRequest": { + "base": null, + "refs": { + } + }, + "PutAccountAliasResult": { + "base": null, + "refs": { + } + }, + "ResourceNotFoundException": { + "base": "

The specified resource is missing or doesn't exist, such as an account alias or Slack channel configuration.

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

Your Service Quotas request exceeds the quota for the service. For example, your Service Quotas request to Amazon Web Services Support App might exceed the maximum number of workspaces or channels per account, or the maximum number of accounts per Slack channel.

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

The configuration for a Slack channel that you added to an Amazon Web Services account.

", + "refs": { + "slackChannelConfigurationList$member": null + } + }, + "SlackWorkspaceConfiguration": { + "base": "

The configuration for a Slack workspace that you added to an Amazon Web Services account.

", + "refs": { + "SlackWorkspaceConfigurationList$member": null + } + }, + "SlackWorkspaceConfigurationList": { + "base": null, + "refs": { + "ListSlackWorkspaceConfigurationsResult$slackWorkspaceConfigurations": "

The configurations for a Slack workspace.

" + } + }, + "UpdateSlackChannelConfigurationRequest": { + "base": null, + "refs": { + } + }, + "UpdateSlackChannelConfigurationResult": { + "base": null, + "refs": { + } + }, + "ValidationException": { + "base": "

Your request input doesn't meet the constraints that the Amazon Web Services Support App specifies.

", + "refs": { + } + }, + "awsAccountAlias": { + "base": null, + "refs": { + "GetAccountAliasResult$accountAlias": "

An alias or short name for an Amazon Web Services account.

", + "PutAccountAliasRequest$accountAlias": "

An alias or short name for an Amazon Web Services account.

" + } + }, + "booleanValue": { + "base": null, + "refs": { + "CreateSlackChannelConfigurationRequest$notifyOnAddCorrespondenceToCase": "

Whether you want to get notified when a support case has a new correspondence.

", + "CreateSlackChannelConfigurationRequest$notifyOnCreateOrReopenCase": "

Whether you want to get notified when a support case is created or reopened.

", + "CreateSlackChannelConfigurationRequest$notifyOnResolveCase": "

Whether you want to get notified when a support case is resolved.

", + "SlackChannelConfiguration$notifyOnAddCorrespondenceToCase": "

Whether you want to get notified when a support case has a new correspondence.

", + "SlackChannelConfiguration$notifyOnCreateOrReopenCase": "

Whether you want to get notified when a support case is created or reopened.

", + "SlackChannelConfiguration$notifyOnResolveCase": "

Whether you want to get notified when a support case is resolved.

", + "UpdateSlackChannelConfigurationRequest$notifyOnAddCorrespondenceToCase": "

Whether you want to get notified when a support case has a new correspondence.

", + "UpdateSlackChannelConfigurationRequest$notifyOnCreateOrReopenCase": "

Whether you want to get notified when a support case is created or reopened.

", + "UpdateSlackChannelConfigurationRequest$notifyOnResolveCase": "

Whether you want to get notified when a support case is resolved.

", + "UpdateSlackChannelConfigurationResult$notifyOnAddCorrespondenceToCase": "

Whether you want to get notified when a support case has a new correspondence.

", + "UpdateSlackChannelConfigurationResult$notifyOnCreateOrReopenCase": "

Whether you want to get notified when a support case is created or reopened.

", + "UpdateSlackChannelConfigurationResult$notifyOnResolveCase": "

Whether you want to get notified when a support case is resolved.

" + } + }, + "channelId": { + "base": null, + "refs": { + "CreateSlackChannelConfigurationRequest$channelId": "

The channel ID in Slack. This ID identifies a channel within a Slack workspace.

", + "DeleteSlackChannelConfigurationRequest$channelId": "

The channel ID in Slack. This ID identifies a channel within a Slack workspace.

", + "SlackChannelConfiguration$channelId": "

The channel ID in Slack. This ID identifies a channel within a Slack workspace.

", + "UpdateSlackChannelConfigurationRequest$channelId": "

The channel ID in Slack. This ID identifies a channel within a Slack workspace.

", + "UpdateSlackChannelConfigurationResult$channelId": "

The channel ID in Slack. This ID identifies a channel within a Slack workspace.

" + } + }, + "channelName": { + "base": null, + "refs": { + "CreateSlackChannelConfigurationRequest$channelName": "

The name of the Slack channel that you configure for the Amazon Web Services Support App.

", + "SlackChannelConfiguration$channelName": "

The name of the Slack channel that you configured with the Amazon Web Services Support App.

", + "UpdateSlackChannelConfigurationRequest$channelName": "

The Slack channel name that you want to update.

", + "UpdateSlackChannelConfigurationResult$channelName": "

The name of the Slack channel that you configure for the Amazon Web Services Support App.

" + } + }, + "errorMessage": { + "base": null, + "refs": { + "AccessDeniedException$message": null, + "ConflictException$message": null, + "InternalServerException$message": null, + "ResourceNotFoundException$message": null, + "ServiceQuotaExceededException$message": null, + "ValidationException$message": null + } + }, + "paginationToken": { + "base": null, + "refs": { + "ListSlackChannelConfigurationsRequest$nextToken": "

If the results of a search are large, the API only returns a portion of the results and includes a nextToken pagination token in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When the API returns the last set of results, the response doesn't include a pagination token value.

", + "ListSlackChannelConfigurationsResult$nextToken": "

The point where pagination should resume when the response returns only partial results.

", + "ListSlackWorkspaceConfigurationsRequest$nextToken": "

If the results of a search are large, the API only returns a portion of the results and includes a nextToken pagination token in the response. To retrieve the next batch of results, reissue the search request and include the returned token. When the API returns the last set of results, the response doesn't include a pagination token value.

", + "ListSlackWorkspaceConfigurationsResult$nextToken": "

The point where pagination should resume when the response returns only partial results.

" + } + }, + "roleArn": { + "base": null, + "refs": { + "CreateSlackChannelConfigurationRequest$channelRoleArn": "

The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.

", + "SlackChannelConfiguration$channelRoleArn": "

The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.

", + "UpdateSlackChannelConfigurationRequest$channelRoleArn": "

The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.

", + "UpdateSlackChannelConfigurationResult$channelRoleArn": "

The Amazon Resource Name (ARN) of an IAM role that you want to use to perform operations on Amazon Web Services. For more information, see Managing access to the Amazon Web Services Support App in the Amazon Web Services Support User Guide.

" + } + }, + "slackChannelConfigurationList": { + "base": null, + "refs": { + "ListSlackChannelConfigurationsResult$slackChannelConfigurations": "

The configurations for a Slack channel.

" + } + }, + "teamId": { + "base": null, + "refs": { + "CreateSlackChannelConfigurationRequest$teamId": "

The team ID in Slack. This ID uniquely identifies a Slack workspace.

", + "DeleteSlackChannelConfigurationRequest$teamId": "

The team ID in Slack. This ID uniquely identifies a Slack workspace.

", + "DeleteSlackWorkspaceConfigurationRequest$teamId": "

The team ID in Slack. This ID uniquely identifies a Slack workspace.

", + "SlackChannelConfiguration$teamId": "

The team ID in Slack. This ID uniquely identifies a Slack workspace.

", + "SlackWorkspaceConfiguration$teamId": "

The team ID in Slack. This ID uniquely identifies a Slack workspace.

", + "UpdateSlackChannelConfigurationRequest$teamId": "

The team ID in Slack. This ID uniquely identifies a Slack workspace.

", + "UpdateSlackChannelConfigurationResult$teamId": "

The team ID in Slack. This ID uniquely identifies a Slack workspace.

" + } + } + } +} diff --git a/models/apis/support-app/2021-08-20/examples-1.json b/models/apis/support-app/2021-08-20/examples-1.json new file mode 100644 index 0000000000..0ea7e3b0bb --- /dev/null +++ b/models/apis/support-app/2021-08-20/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/models/apis/support-app/2021-08-20/paginators-1.json b/models/apis/support-app/2021-08-20/paginators-1.json new file mode 100644 index 0000000000..a5bf241637 --- /dev/null +++ b/models/apis/support-app/2021-08-20/paginators-1.json @@ -0,0 +1,12 @@ +{ + "pagination": { + "ListSlackChannelConfigurations": { + "input_token": "nextToken", + "output_token": "nextToken" + }, + "ListSlackWorkspaceConfigurations": { + "input_token": "nextToken", + "output_token": "nextToken" + } + } +} diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 7a2fdea478..07cfee8fe5 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -969,6 +969,7 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -7554,6 +7555,13 @@ "deprecated" : true, "hostname" : "kms-fips.eu-west-3.amazonaws.com" }, + "me-central-1-fips" : { + "credentialScope" : { + "region" : "me-central-1" + }, + "deprecated" : true, + "hostname" : "kms-fips.me-central-1.amazonaws.com" + }, "me-south-1" : { "variants" : [ { "hostname" : "kms-fips.me-south-1.amazonaws.com", @@ -12785,6 +12793,13 @@ }, "partitionEndpoint" : "aws-global" }, + "supportapp" : { + "endpoints" : { + "eu-west-1" : { }, + "us-east-1" : { }, + "us-west-2" : { } + } + }, "swf" : { "endpoints" : { "af-south-1" : { }, @@ -19995,6 +20010,16 @@ "us-isob-east-1" : { } } }, + "metering.marketplace" : { + "defaults" : { + "credentialScope" : { + "service" : "aws-marketplace" + } + }, + "endpoints" : { + "us-isob-east-1" : { } + } + }, "monitoring" : { "endpoints" : { "us-isob-east-1" : { } diff --git a/service/docdb/api.go b/service/docdb/api.go index 0fcc11913c..81c23375d2 100644 --- a/service/docdb/api.go +++ b/service/docdb/api.go @@ -15088,9 +15088,6 @@ type RestoreDBClusterToPointInTimeInput struct { // * copy-on-write - The new DB cluster is restored as a clone of the source // DB cluster. // - // Constraints: You can't specify copy-on-write if the engine version of the - // source DB cluster is earlier than 1.11. - // // If you don't specify a RestoreType value, then the new DB cluster is restored // as a full copy of the source DB cluster. RestoreType *string `type:"string"` diff --git a/service/ec2/api.go b/service/ec2/api.go index 3df79953d4..e5606622ea 100644 --- a/service/ec2/api.go +++ b/service/ec2/api.go @@ -64245,8 +64245,12 @@ type CreateLaunchTemplateInput struct { // The information for the launch template. // + // LaunchTemplateData is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateLaunchTemplateInput's + // String and GoString methods. + // // LaunchTemplateData is a required field - LaunchTemplateData *RequestLaunchTemplateData `type:"structure" required:"true"` + LaunchTemplateData *RequestLaunchTemplateData `type:"structure" required:"true" sensitive:"true"` // A name for the launch template. // @@ -64403,8 +64407,12 @@ type CreateLaunchTemplateVersionInput struct { // The information for the launch template. // + // LaunchTemplateData is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateLaunchTemplateVersionInput's + // String and GoString methods. + // // LaunchTemplateData is a required field - LaunchTemplateData *RequestLaunchTemplateData `type:"structure" required:"true"` + LaunchTemplateData *RequestLaunchTemplateData `type:"structure" required:"true" sensitive:"true"` // The ID of the launch template. // @@ -142706,7 +142714,7 @@ func (s *RequestIpamResourceTag) SetValue(v string) *RequestIpamResourceTag { // // You must specify at least one parameter for the launch template data. type RequestLaunchTemplateData struct { - _ struct{} `type:"structure"` + _ struct{} `type:"structure" sensitive:"true"` // The block device mapping. BlockDeviceMappings []*LaunchTemplateBlockDeviceMappingRequest `locationName:"BlockDeviceMapping" locationNameList:"BlockDeviceMapping" type:"list"` @@ -167939,6 +167947,132 @@ const ( // InstanceTypeMac2Metal is a InstanceType enum value InstanceTypeMac2Metal = "mac2.metal" + + // InstanceTypeC6idLarge is a InstanceType enum value + InstanceTypeC6idLarge = "c6id.large" + + // InstanceTypeC6idXlarge is a InstanceType enum value + InstanceTypeC6idXlarge = "c6id.xlarge" + + // InstanceTypeC6id2xlarge is a InstanceType enum value + InstanceTypeC6id2xlarge = "c6id.2xlarge" + + // InstanceTypeC6id4xlarge is a InstanceType enum value + InstanceTypeC6id4xlarge = "c6id.4xlarge" + + // InstanceTypeC6id8xlarge is a InstanceType enum value + InstanceTypeC6id8xlarge = "c6id.8xlarge" + + // InstanceTypeC6id12xlarge is a InstanceType enum value + InstanceTypeC6id12xlarge = "c6id.12xlarge" + + // InstanceTypeC6id16xlarge is a InstanceType enum value + InstanceTypeC6id16xlarge = "c6id.16xlarge" + + // InstanceTypeC6id24xlarge is a InstanceType enum value + InstanceTypeC6id24xlarge = "c6id.24xlarge" + + // InstanceTypeC6id32xlarge is a InstanceType enum value + InstanceTypeC6id32xlarge = "c6id.32xlarge" + + // InstanceTypeC6idMetal is a InstanceType enum value + InstanceTypeC6idMetal = "c6id.metal" + + // InstanceTypeM6idLarge is a InstanceType enum value + InstanceTypeM6idLarge = "m6id.large" + + // InstanceTypeM6idXlarge is a InstanceType enum value + InstanceTypeM6idXlarge = "m6id.xlarge" + + // InstanceTypeM6id2xlarge is a InstanceType enum value + InstanceTypeM6id2xlarge = "m6id.2xlarge" + + // InstanceTypeM6id4xlarge is a InstanceType enum value + InstanceTypeM6id4xlarge = "m6id.4xlarge" + + // InstanceTypeM6id8xlarge is a InstanceType enum value + InstanceTypeM6id8xlarge = "m6id.8xlarge" + + // InstanceTypeM6id12xlarge is a InstanceType enum value + InstanceTypeM6id12xlarge = "m6id.12xlarge" + + // InstanceTypeM6id16xlarge is a InstanceType enum value + InstanceTypeM6id16xlarge = "m6id.16xlarge" + + // InstanceTypeM6id24xlarge is a InstanceType enum value + InstanceTypeM6id24xlarge = "m6id.24xlarge" + + // InstanceTypeM6id32xlarge is a InstanceType enum value + InstanceTypeM6id32xlarge = "m6id.32xlarge" + + // InstanceTypeM6idMetal is a InstanceType enum value + InstanceTypeM6idMetal = "m6id.metal" + + // InstanceTypeR6idLarge is a InstanceType enum value + InstanceTypeR6idLarge = "r6id.large" + + // InstanceTypeR6idXlarge is a InstanceType enum value + InstanceTypeR6idXlarge = "r6id.xlarge" + + // InstanceTypeR6id2xlarge is a InstanceType enum value + InstanceTypeR6id2xlarge = "r6id.2xlarge" + + // InstanceTypeR6id4xlarge is a InstanceType enum value + InstanceTypeR6id4xlarge = "r6id.4xlarge" + + // InstanceTypeR6id8xlarge is a InstanceType enum value + InstanceTypeR6id8xlarge = "r6id.8xlarge" + + // InstanceTypeR6id12xlarge is a InstanceType enum value + InstanceTypeR6id12xlarge = "r6id.12xlarge" + + // InstanceTypeR6id16xlarge is a InstanceType enum value + InstanceTypeR6id16xlarge = "r6id.16xlarge" + + // InstanceTypeR6id24xlarge is a InstanceType enum value + InstanceTypeR6id24xlarge = "r6id.24xlarge" + + // InstanceTypeR6id32xlarge is a InstanceType enum value + InstanceTypeR6id32xlarge = "r6id.32xlarge" + + // InstanceTypeR6idMetal is a InstanceType enum value + InstanceTypeR6idMetal = "r6id.metal" + + // InstanceTypeR6aLarge is a InstanceType enum value + InstanceTypeR6aLarge = "r6a.large" + + // InstanceTypeR6aXlarge is a InstanceType enum value + InstanceTypeR6aXlarge = "r6a.xlarge" + + // InstanceTypeR6a2xlarge is a InstanceType enum value + InstanceTypeR6a2xlarge = "r6a.2xlarge" + + // InstanceTypeR6a4xlarge is a InstanceType enum value + InstanceTypeR6a4xlarge = "r6a.4xlarge" + + // InstanceTypeR6a8xlarge is a InstanceType enum value + InstanceTypeR6a8xlarge = "r6a.8xlarge" + + // InstanceTypeR6a12xlarge is a InstanceType enum value + InstanceTypeR6a12xlarge = "r6a.12xlarge" + + // InstanceTypeR6a16xlarge is a InstanceType enum value + InstanceTypeR6a16xlarge = "r6a.16xlarge" + + // InstanceTypeR6a24xlarge is a InstanceType enum value + InstanceTypeR6a24xlarge = "r6a.24xlarge" + + // InstanceTypeR6a32xlarge is a InstanceType enum value + InstanceTypeR6a32xlarge = "r6a.32xlarge" + + // InstanceTypeR6a48xlarge is a InstanceType enum value + InstanceTypeR6a48xlarge = "r6a.48xlarge" + + // InstanceTypeR6aMetal is a InstanceType enum value + InstanceTypeR6aMetal = "r6a.metal" + + // InstanceTypeP4de24xlarge is a InstanceType enum value + InstanceTypeP4de24xlarge = "p4de.24xlarge" ) // InstanceType_Values returns all elements of the InstanceType enum @@ -168470,6 +168604,48 @@ func InstanceType_Values() []string { InstanceTypeC7g12xlarge, InstanceTypeC7g16xlarge, InstanceTypeMac2Metal, + InstanceTypeC6idLarge, + InstanceTypeC6idXlarge, + InstanceTypeC6id2xlarge, + InstanceTypeC6id4xlarge, + InstanceTypeC6id8xlarge, + InstanceTypeC6id12xlarge, + InstanceTypeC6id16xlarge, + InstanceTypeC6id24xlarge, + InstanceTypeC6id32xlarge, + InstanceTypeC6idMetal, + InstanceTypeM6idLarge, + InstanceTypeM6idXlarge, + InstanceTypeM6id2xlarge, + InstanceTypeM6id4xlarge, + InstanceTypeM6id8xlarge, + InstanceTypeM6id12xlarge, + InstanceTypeM6id16xlarge, + InstanceTypeM6id24xlarge, + InstanceTypeM6id32xlarge, + InstanceTypeM6idMetal, + InstanceTypeR6idLarge, + InstanceTypeR6idXlarge, + InstanceTypeR6id2xlarge, + InstanceTypeR6id4xlarge, + InstanceTypeR6id8xlarge, + InstanceTypeR6id12xlarge, + InstanceTypeR6id16xlarge, + InstanceTypeR6id24xlarge, + InstanceTypeR6id32xlarge, + InstanceTypeR6idMetal, + InstanceTypeR6aLarge, + InstanceTypeR6aXlarge, + InstanceTypeR6a2xlarge, + InstanceTypeR6a4xlarge, + InstanceTypeR6a8xlarge, + InstanceTypeR6a12xlarge, + InstanceTypeR6a16xlarge, + InstanceTypeR6a24xlarge, + InstanceTypeR6a32xlarge, + InstanceTypeR6a48xlarge, + InstanceTypeR6aMetal, + InstanceTypeP4de24xlarge, } } diff --git a/service/forecastqueryservice/api.go b/service/forecastqueryservice/api.go index eb739f42ba..a0dc885acf 100644 --- a/service/forecastqueryservice/api.go +++ b/service/forecastqueryservice/api.go @@ -117,6 +117,98 @@ func (c *ForecastQueryService) QueryForecastWithContext(ctx aws.Context, input * return out, req.Send() } +const opQueryWhatIfForecast = "QueryWhatIfForecast" + +// QueryWhatIfForecastRequest generates a "aws/request.Request" representing the +// client's request for the QueryWhatIfForecast 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 QueryWhatIfForecast for more information on using the QueryWhatIfForecast +// 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 QueryWhatIfForecastRequest method. +// req, resp := client.QueryWhatIfForecastRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26/QueryWhatIfForecast +func (c *ForecastQueryService) QueryWhatIfForecastRequest(input *QueryWhatIfForecastInput) (req *request.Request, output *QueryWhatIfForecastOutput) { + op := &request.Operation{ + Name: opQueryWhatIfForecast, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &QueryWhatIfForecastInput{} + } + + output = &QueryWhatIfForecastOutput{} + req = c.newRequest(op, input, output) + return +} + +// QueryWhatIfForecast API operation for Amazon Forecast Query Service. +// +// Retrieves a what-if 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 Query Service's +// API operation QueryWhatIfForecast for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// We can't find that resource. Check the information that you've provided and +// try again. +// +// - ResourceInUseException +// The specified resource is in use. +// +// - InvalidInputException +// The value is invalid or is too long. +// +// - LimitExceededException +// The limit on the number of requests per second has been exceeded. +// +// - InvalidNextTokenException +// The token is not valid. Tokens expire after 24 hours. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecastquery-2018-06-26/QueryWhatIfForecast +func (c *ForecastQueryService) QueryWhatIfForecast(input *QueryWhatIfForecastInput) (*QueryWhatIfForecastOutput, error) { + req, out := c.QueryWhatIfForecastRequest(input) + return out, req.Send() +} + +// QueryWhatIfForecastWithContext is the same as QueryWhatIfForecast with the addition of +// the ability to pass a context and additional request options. +// +// See QueryWhatIfForecast 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 *ForecastQueryService) QueryWhatIfForecastWithContext(ctx aws.Context, input *QueryWhatIfForecastInput, opts ...request.Option) (*QueryWhatIfForecastOutput, error) { + req, out := c.QueryWhatIfForecastRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + // The forecast value for a specific date. Part of the Forecast object. type DataPoint struct { _ struct{} `type:"structure"` @@ -172,6 +264,11 @@ type Forecast struct { // * p50 // // * p90 + // + // The default setting is ["0.1", "0.5", "0.9"]. Use the optional ForecastTypes + // parameter of the CreateForecast (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateForecast.html) + // operation to change the values. The values will vary depending on how this + // is set, with a minimum of 1 and a maximum of 5. Predictions map[string][]*DataPoint `type:"map"` } @@ -526,6 +623,142 @@ func (s *QueryForecastOutput) SetForecast(v *Forecast) *QueryForecastOutput { return s } +type QueryWhatIfForecastInput struct { + _ struct{} `type:"structure"` + + // The end date for the what-if forecast. Specify the date using this format: + // yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T20:00:00. + EndDate *string `type:"string"` + + // The filtering criteria to apply when retrieving the forecast. For example, + // to get the forecast for client_21 in the electricity usage dataset, specify + // the following: + // + // {"item_id" : "client_21"} + // + // To get the full what-if forecast, use the CreateForecastExportJob (https://docs.aws.amazon.com/en_us/forecast/latest/dg/API_CreateWhatIfForecastExport.html) + // operation. + // + // Filters is a required field + Filters map[string]*string `min:"1" type:"map" required:"true"` + + // 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"` + + // The start date for the what-if forecast. Specify the date using this format: + // yyyy-MM-dd'T'HH:mm:ss (ISO 8601 format). For example, 2015-01-01T08:00:00. + StartDate *string `type:"string"` + + // The Amazon Resource Name (ARN) of the what-if forecast to query. + // + // WhatIfForecastArn is a required field + WhatIfForecastArn *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 QueryWhatIfForecastInput) 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 QueryWhatIfForecastInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *QueryWhatIfForecastInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "QueryWhatIfForecastInput"} + if s.Filters == nil { + invalidParams.Add(request.NewErrParamRequired("Filters")) + } + if s.Filters != nil && len(s.Filters) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Filters", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.WhatIfForecastArn == nil { + invalidParams.Add(request.NewErrParamRequired("WhatIfForecastArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetEndDate sets the EndDate field's value. +func (s *QueryWhatIfForecastInput) SetEndDate(v string) *QueryWhatIfForecastInput { + s.EndDate = &v + return s +} + +// SetFilters sets the Filters field's value. +func (s *QueryWhatIfForecastInput) SetFilters(v map[string]*string) *QueryWhatIfForecastInput { + s.Filters = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *QueryWhatIfForecastInput) SetNextToken(v string) *QueryWhatIfForecastInput { + s.NextToken = &v + return s +} + +// SetStartDate sets the StartDate field's value. +func (s *QueryWhatIfForecastInput) SetStartDate(v string) *QueryWhatIfForecastInput { + s.StartDate = &v + return s +} + +// SetWhatIfForecastArn sets the WhatIfForecastArn field's value. +func (s *QueryWhatIfForecastInput) SetWhatIfForecastArn(v string) *QueryWhatIfForecastInput { + s.WhatIfForecastArn = &v + return s +} + +type QueryWhatIfForecastOutput struct { + _ struct{} `type:"structure"` + + // Provides information about a forecast. Returned as part of the QueryForecast + // response. + Forecast *Forecast `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 QueryWhatIfForecastOutput) 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 QueryWhatIfForecastOutput) GoString() string { + return s.String() +} + +// SetForecast sets the Forecast field's value. +func (s *QueryWhatIfForecastOutput) SetForecast(v *Forecast) *QueryWhatIfForecastOutput { + s.Forecast = v + return s +} + // The specified resource is in use. type ResourceInUseException struct { _ struct{} `type:"structure"` diff --git a/service/forecastqueryservice/forecastqueryserviceiface/interface.go b/service/forecastqueryservice/forecastqueryserviceiface/interface.go index 93a7e349c1..c4a776d5a7 100644 --- a/service/forecastqueryservice/forecastqueryserviceiface/interface.go +++ b/service/forecastqueryservice/forecastqueryserviceiface/interface.go @@ -63,6 +63,10 @@ type ForecastQueryServiceAPI interface { QueryForecast(*forecastqueryservice.QueryForecastInput) (*forecastqueryservice.QueryForecastOutput, error) QueryForecastWithContext(aws.Context, *forecastqueryservice.QueryForecastInput, ...request.Option) (*forecastqueryservice.QueryForecastOutput, error) QueryForecastRequest(*forecastqueryservice.QueryForecastInput) (*request.Request, *forecastqueryservice.QueryForecastOutput) + + QueryWhatIfForecast(*forecastqueryservice.QueryWhatIfForecastInput) (*forecastqueryservice.QueryWhatIfForecastOutput, error) + QueryWhatIfForecastWithContext(aws.Context, *forecastqueryservice.QueryWhatIfForecastInput, ...request.Option) (*forecastqueryservice.QueryWhatIfForecastOutput, error) + QueryWhatIfForecastRequest(*forecastqueryservice.QueryWhatIfForecastInput) (*request.Request, *forecastqueryservice.QueryWhatIfForecastOutput) } var _ ForecastQueryServiceAPI = (*forecastqueryservice.ForecastQueryService)(nil) diff --git a/service/forecastservice/api.go b/service/forecastservice/api.go index ead2780920..13e5429fe9 100644 --- a/service/forecastservice/api.go +++ b/service/forecastservice/api.go @@ -1323,6 +1323,328 @@ func (c *ForecastService) CreatePredictorBacktestExportJobWithContext(ctx aws.Co return out, req.Send() } +const opCreateWhatIfAnalysis = "CreateWhatIfAnalysis" + +// CreateWhatIfAnalysisRequest generates a "aws/request.Request" representing the +// client's request for the CreateWhatIfAnalysis 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 CreateWhatIfAnalysis for more information on using the CreateWhatIfAnalysis +// 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 CreateWhatIfAnalysisRequest method. +// req, resp := client.CreateWhatIfAnalysisRequest(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/CreateWhatIfAnalysis +func (c *ForecastService) CreateWhatIfAnalysisRequest(input *CreateWhatIfAnalysisInput) (req *request.Request, output *CreateWhatIfAnalysisOutput) { + op := &request.Operation{ + Name: opCreateWhatIfAnalysis, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateWhatIfAnalysisInput{} + } + + output = &CreateWhatIfAnalysisOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateWhatIfAnalysis API operation for Amazon Forecast Service. +// +// What-if analysis is a scenario modeling technique where you make a hypothetical +// change to a time series and compare the forecasts generated by these changes +// against the baseline, unchanged time series. It is important to remember +// that the purpose of a what-if analysis is to understand how a forecast can +// change given different modifications to the baseline time series. +// +// For example, imagine you are a clothing retailer who is considering an end +// of season sale to clear space for new styles. After creating a baseline forecast, +// you can use a what-if analysis to investigate how different sales tactics +// might affect your goals. You could create a scenario where everything is +// given a 25% markdown and another where everything is given a fixed dollar +// markdown. You can create a scenario where the sale lasts for 1 week and another +// where the sale lasts for 1 month. Your what-if analysis enables you to compare +// many different scenarios against each other. +// +// Note that a what-if analysis is meant to display what the forecasting model +// has learned and how it will behave in the scenarios that you are evaluating. +// Do not blindly use the results of the what-if analysis to make business decisions. +// For instance, forecasts might not be accurate for novel scenarios where there +// is no reference available to determine whether a forecast is good. +// +// The TimeSeriesSelector object defines the items that you want in the what-if +// analysis. +// +// 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 CreateWhatIfAnalysis 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/CreateWhatIfAnalysis +func (c *ForecastService) CreateWhatIfAnalysis(input *CreateWhatIfAnalysisInput) (*CreateWhatIfAnalysisOutput, error) { + req, out := c.CreateWhatIfAnalysisRequest(input) + return out, req.Send() +} + +// CreateWhatIfAnalysisWithContext is the same as CreateWhatIfAnalysis with the addition of +// the ability to pass a context and additional request options. +// +// See CreateWhatIfAnalysis 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) CreateWhatIfAnalysisWithContext(ctx aws.Context, input *CreateWhatIfAnalysisInput, opts ...request.Option) (*CreateWhatIfAnalysisOutput, error) { + req, out := c.CreateWhatIfAnalysisRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateWhatIfForecast = "CreateWhatIfForecast" + +// CreateWhatIfForecastRequest generates a "aws/request.Request" representing the +// client's request for the CreateWhatIfForecast 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 CreateWhatIfForecast for more information on using the CreateWhatIfForecast +// 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 CreateWhatIfForecastRequest method. +// req, resp := client.CreateWhatIfForecastRequest(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/CreateWhatIfForecast +func (c *ForecastService) CreateWhatIfForecastRequest(input *CreateWhatIfForecastInput) (req *request.Request, output *CreateWhatIfForecastOutput) { + op := &request.Operation{ + Name: opCreateWhatIfForecast, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateWhatIfForecastInput{} + } + + output = &CreateWhatIfForecastOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateWhatIfForecast API operation for Amazon Forecast Service. +// +// A what-if forecast is a forecast that is created from a modified version +// of the baseline forecast. Each what-if forecast incorporates either a replacement +// dataset or a set of transformations to the original 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 Amazon Forecast Service's +// API operation CreateWhatIfForecast 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/CreateWhatIfForecast +func (c *ForecastService) CreateWhatIfForecast(input *CreateWhatIfForecastInput) (*CreateWhatIfForecastOutput, error) { + req, out := c.CreateWhatIfForecastRequest(input) + return out, req.Send() +} + +// CreateWhatIfForecastWithContext is the same as CreateWhatIfForecast with the addition of +// the ability to pass a context and additional request options. +// +// See CreateWhatIfForecast 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) CreateWhatIfForecastWithContext(ctx aws.Context, input *CreateWhatIfForecastInput, opts ...request.Option) (*CreateWhatIfForecastOutput, error) { + req, out := c.CreateWhatIfForecastRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opCreateWhatIfForecastExport = "CreateWhatIfForecastExport" + +// CreateWhatIfForecastExportRequest generates a "aws/request.Request" representing the +// client's request for the CreateWhatIfForecastExport 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 CreateWhatIfForecastExport for more information on using the CreateWhatIfForecastExport +// 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 CreateWhatIfForecastExportRequest method. +// req, resp := client.CreateWhatIfForecastExportRequest(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/CreateWhatIfForecastExport +func (c *ForecastService) CreateWhatIfForecastExportRequest(input *CreateWhatIfForecastExportInput) (req *request.Request, output *CreateWhatIfForecastExportOutput) { + op := &request.Operation{ + Name: opCreateWhatIfForecastExport, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateWhatIfForecastExportInput{} + } + + output = &CreateWhatIfForecastExportOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateWhatIfForecastExport API operation for Amazon Forecast Service. +// +// Exports a forecast created by the CreateWhatIfForecast operation to your +// Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name +// will match the following conventions: +// +// ≈__ +// +// 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 what-if forecast export jobs, use the ListWhatIfForecastExports +// 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 DescribeWhatIfForecastExport +// 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 CreateWhatIfForecastExport 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/CreateWhatIfForecastExport +func (c *ForecastService) CreateWhatIfForecastExport(input *CreateWhatIfForecastExportInput) (*CreateWhatIfForecastExportOutput, error) { + req, out := c.CreateWhatIfForecastExportRequest(input) + return out, req.Send() +} + +// CreateWhatIfForecastExportWithContext is the same as CreateWhatIfForecastExport with the addition of +// the ability to pass a context and additional request options. +// +// See CreateWhatIfForecastExport 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) CreateWhatIfForecastExportWithContext(ctx aws.Context, input *CreateWhatIfForecastExportInput, opts ...request.Option) (*CreateWhatIfForecastExportOutput, error) { + req, out := c.CreateWhatIfForecastExportRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDeleteDataset = "DeleteDataset" // DeleteDatasetRequest generates a "aws/request.Request" representing the @@ -2343,57 +2665,63 @@ func (c *ForecastService) DeleteResourceTreeWithContext(ctx aws.Context, input * return out, req.Send() } -const opDescribeAutoPredictor = "DescribeAutoPredictor" +const opDeleteWhatIfAnalysis = "DeleteWhatIfAnalysis" -// DescribeAutoPredictorRequest generates a "aws/request.Request" representing the -// client's request for the DescribeAutoPredictor operation. The "output" return +// DeleteWhatIfAnalysisRequest generates a "aws/request.Request" representing the +// client's request for the DeleteWhatIfAnalysis 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 +// See DeleteWhatIfAnalysis for more information on using the DeleteWhatIfAnalysis // 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) +// // Example sending a request using the DeleteWhatIfAnalysisRequest method. +// req, resp := client.DeleteWhatIfAnalysisRequest(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) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteWhatIfAnalysis +func (c *ForecastService) DeleteWhatIfAnalysisRequest(input *DeleteWhatIfAnalysisInput) (req *request.Request, output *DeleteWhatIfAnalysisOutput) { op := &request.Operation{ - Name: opDescribeAutoPredictor, + Name: opDeleteWhatIfAnalysis, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &DescribeAutoPredictorInput{} + input = &DeleteWhatIfAnalysisInput{} } - output = &DescribeAutoPredictorOutput{} + output = &DeleteWhatIfAnalysisOutput{} req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// DescribeAutoPredictor API operation for Amazon Forecast Service. +// DeleteWhatIfAnalysis API operation for Amazon Forecast Service. // -// Describes a predictor created using the CreateAutoPredictor operation. +// Deletes a what-if analysis created using the CreateWhatIfAnalysis operation. +// You can delete only what-if analyses that have a status of ACTIVE or CREATE_FAILED. +// To get the status, use the DescribeWhatIfAnalysis operation. +// +// You can't delete a what-if analysis while any of its forecasts are being +// exported. // // 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. +// API operation DeleteWhatIfAnalysis for usage and error information. // // Returned Error Types: // @@ -2405,16 +2733,287 @@ func (c *ForecastService) DescribeAutoPredictorRequest(input *DescribeAutoPredic // 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) +// - ResourceInUseException +// The specified resource is in use. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DeleteWhatIfAnalysis +func (c *ForecastService) DeleteWhatIfAnalysis(input *DeleteWhatIfAnalysisInput) (*DeleteWhatIfAnalysisOutput, error) { + req, out := c.DeleteWhatIfAnalysisRequest(input) return out, req.Send() } -// DescribeAutoPredictorWithContext is the same as DescribeAutoPredictor with the addition of +// DeleteWhatIfAnalysisWithContext is the same as DeleteWhatIfAnalysis 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. +// See DeleteWhatIfAnalysis 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) DeleteWhatIfAnalysisWithContext(ctx aws.Context, input *DeleteWhatIfAnalysisInput, opts ...request.Option) (*DeleteWhatIfAnalysisOutput, error) { + req, out := c.DeleteWhatIfAnalysisRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteWhatIfForecast = "DeleteWhatIfForecast" + +// DeleteWhatIfForecastRequest generates a "aws/request.Request" representing the +// client's request for the DeleteWhatIfForecast 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 DeleteWhatIfForecast for more information on using the DeleteWhatIfForecast +// 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 DeleteWhatIfForecastRequest method. +// req, resp := client.DeleteWhatIfForecastRequest(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/DeleteWhatIfForecast +func (c *ForecastService) DeleteWhatIfForecastRequest(input *DeleteWhatIfForecastInput) (req *request.Request, output *DeleteWhatIfForecastOutput) { + op := &request.Operation{ + Name: opDeleteWhatIfForecast, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteWhatIfForecastInput{} + } + + output = &DeleteWhatIfForecastOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteWhatIfForecast API operation for Amazon Forecast Service. +// +// Deletes a what-if forecast created using the CreateWhatIfForecast operation. +// You can delete only what-if forecasts that have a status of ACTIVE or CREATE_FAILED. +// To get the status, use the DescribeWhatIfForecast operation. +// +// You can't delete a what-if forecast while it is being exported. After a what-if +// forecast is deleted, you can no longer query the what-if analysis. +// +// 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 DeleteWhatIfForecast 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/DeleteWhatIfForecast +func (c *ForecastService) DeleteWhatIfForecast(input *DeleteWhatIfForecastInput) (*DeleteWhatIfForecastOutput, error) { + req, out := c.DeleteWhatIfForecastRequest(input) + return out, req.Send() +} + +// DeleteWhatIfForecastWithContext is the same as DeleteWhatIfForecast with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteWhatIfForecast 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) DeleteWhatIfForecastWithContext(ctx aws.Context, input *DeleteWhatIfForecastInput, opts ...request.Option) (*DeleteWhatIfForecastOutput, error) { + req, out := c.DeleteWhatIfForecastRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteWhatIfForecastExport = "DeleteWhatIfForecastExport" + +// DeleteWhatIfForecastExportRequest generates a "aws/request.Request" representing the +// client's request for the DeleteWhatIfForecastExport 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 DeleteWhatIfForecastExport for more information on using the DeleteWhatIfForecastExport +// 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 DeleteWhatIfForecastExportRequest method. +// req, resp := client.DeleteWhatIfForecastExportRequest(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/DeleteWhatIfForecastExport +func (c *ForecastService) DeleteWhatIfForecastExportRequest(input *DeleteWhatIfForecastExportInput) (req *request.Request, output *DeleteWhatIfForecastExportOutput) { + op := &request.Operation{ + Name: opDeleteWhatIfForecastExport, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteWhatIfForecastExportInput{} + } + + output = &DeleteWhatIfForecastExportOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteWhatIfForecastExport API operation for Amazon Forecast Service. +// +// Deletes a what-if forecast export created using the CreateWhatIfForecastExport +// operation. You can delete only what-if forecast exports that have a status +// of ACTIVE or CREATE_FAILED. To get the status, use the DescribeWhatIfForecastExport +// 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 DeleteWhatIfForecastExport 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/DeleteWhatIfForecastExport +func (c *ForecastService) DeleteWhatIfForecastExport(input *DeleteWhatIfForecastExportInput) (*DeleteWhatIfForecastExportOutput, error) { + req, out := c.DeleteWhatIfForecastExportRequest(input) + return out, req.Send() +} + +// DeleteWhatIfForecastExportWithContext is the same as DeleteWhatIfForecastExport with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteWhatIfForecastExport 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) DeleteWhatIfForecastExportWithContext(ctx aws.Context, input *DeleteWhatIfForecastExportInput, opts ...request.Option) (*DeleteWhatIfForecastExportOutput, error) { + req, out := c.DeleteWhatIfForecastExportRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + 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 @@ -3379,75 +3978,68 @@ func (c *ForecastService) DescribePredictorBacktestExportJobWithContext(ctx aws. return out, req.Send() } -const opGetAccuracyMetrics = "GetAccuracyMetrics" +const opDescribeWhatIfAnalysis = "DescribeWhatIfAnalysis" -// GetAccuracyMetricsRequest generates a "aws/request.Request" representing the -// client's request for the GetAccuracyMetrics operation. The "output" return +// DescribeWhatIfAnalysisRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWhatIfAnalysis 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 GetAccuracyMetrics for more information on using the GetAccuracyMetrics +// See DescribeWhatIfAnalysis for more information on using the DescribeWhatIfAnalysis // 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 GetAccuracyMetricsRequest method. -// req, resp := client.GetAccuracyMetricsRequest(params) +// // Example sending a request using the DescribeWhatIfAnalysisRequest method. +// req, resp := client.DescribeWhatIfAnalysisRequest(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/GetAccuracyMetrics -func (c *ForecastService) GetAccuracyMetricsRequest(input *GetAccuracyMetricsInput) (req *request.Request, output *GetAccuracyMetricsOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeWhatIfAnalysis +func (c *ForecastService) DescribeWhatIfAnalysisRequest(input *DescribeWhatIfAnalysisInput) (req *request.Request, output *DescribeWhatIfAnalysisOutput) { op := &request.Operation{ - Name: opGetAccuracyMetrics, + Name: opDescribeWhatIfAnalysis, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &GetAccuracyMetricsInput{} + input = &DescribeWhatIfAnalysisInput{} } - output = &GetAccuracyMetricsOutput{} + output = &DescribeWhatIfAnalysisOutput{} req = c.newRequest(op, input, output) return } -// GetAccuracyMetrics API operation for Amazon Forecast Service. +// DescribeWhatIfAnalysis API operation for Amazon Forecast Service. // -// 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 (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html). +// Describes the what-if analysis created using the CreateWhatIfAnalysis operation. // -// 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. +// In addition to listing the properties provided in the CreateWhatIfAnalysis +// request, this operation lists the following properties: // -// 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. +// - CreationTime // -// 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. +// - LastModificationTime +// +// - Message - If an error occurred, information about the error. +// +// - Status // // 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 GetAccuracyMetrics for usage and error information. +// API operation DescribeWhatIfAnalysis for usage and error information. // // Returned Error Types: // @@ -3459,8 +4051,301 @@ func (c *ForecastService) GetAccuracyMetricsRequest(input *GetAccuracyMetricsInp // 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/DescribeWhatIfAnalysis +func (c *ForecastService) DescribeWhatIfAnalysis(input *DescribeWhatIfAnalysisInput) (*DescribeWhatIfAnalysisOutput, error) { + req, out := c.DescribeWhatIfAnalysisRequest(input) + return out, req.Send() +} + +// DescribeWhatIfAnalysisWithContext is the same as DescribeWhatIfAnalysis with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeWhatIfAnalysis 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) DescribeWhatIfAnalysisWithContext(ctx aws.Context, input *DescribeWhatIfAnalysisInput, opts ...request.Option) (*DescribeWhatIfAnalysisOutput, error) { + req, out := c.DescribeWhatIfAnalysisRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeWhatIfForecast = "DescribeWhatIfForecast" + +// DescribeWhatIfForecastRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWhatIfForecast 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 DescribeWhatIfForecast for more information on using the DescribeWhatIfForecast +// 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 DescribeWhatIfForecastRequest method. +// req, resp := client.DescribeWhatIfForecastRequest(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/DescribeWhatIfForecast +func (c *ForecastService) DescribeWhatIfForecastRequest(input *DescribeWhatIfForecastInput) (req *request.Request, output *DescribeWhatIfForecastOutput) { + op := &request.Operation{ + Name: opDescribeWhatIfForecast, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeWhatIfForecastInput{} + } + + output = &DescribeWhatIfForecastOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeWhatIfForecast API operation for Amazon Forecast Service. +// +// Describes the what-if forecast created using the CreateWhatIfForecast operation. +// +// In addition to listing the properties provided in the CreateWhatIfForecast +// request, this operation lists the following properties: +// +// - CreationTime +// +// - LastModificationTime +// +// - Message - If an error occurred, information about the error. +// +// - Status +// +// 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 DescribeWhatIfForecast 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/DescribeWhatIfForecast +func (c *ForecastService) DescribeWhatIfForecast(input *DescribeWhatIfForecastInput) (*DescribeWhatIfForecastOutput, error) { + req, out := c.DescribeWhatIfForecastRequest(input) + return out, req.Send() +} + +// DescribeWhatIfForecastWithContext is the same as DescribeWhatIfForecast with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeWhatIfForecast 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) DescribeWhatIfForecastWithContext(ctx aws.Context, input *DescribeWhatIfForecastInput, opts ...request.Option) (*DescribeWhatIfForecastOutput, error) { + req, out := c.DescribeWhatIfForecastRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeWhatIfForecastExport = "DescribeWhatIfForecastExport" + +// DescribeWhatIfForecastExportRequest generates a "aws/request.Request" representing the +// client's request for the DescribeWhatIfForecastExport 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 DescribeWhatIfForecastExport for more information on using the DescribeWhatIfForecastExport +// 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 DescribeWhatIfForecastExportRequest method. +// req, resp := client.DescribeWhatIfForecastExportRequest(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/DescribeWhatIfForecastExport +func (c *ForecastService) DescribeWhatIfForecastExportRequest(input *DescribeWhatIfForecastExportInput) (req *request.Request, output *DescribeWhatIfForecastExportOutput) { + op := &request.Operation{ + Name: opDescribeWhatIfForecastExport, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeWhatIfForecastExportInput{} + } + + output = &DescribeWhatIfForecastExportOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeWhatIfForecastExport API operation for Amazon Forecast Service. +// +// Describes the what-if forecast export created using the CreateWhatIfForecastExport +// operation. +// +// In addition to listing the properties provided in the CreateWhatIfForecastExport +// request, this operation lists the following properties: +// +// - CreationTime +// +// - LastModificationTime +// +// - Message - If an error occurred, information about the error. +// +// - Status +// +// 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 DescribeWhatIfForecastExport 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/DescribeWhatIfForecastExport +func (c *ForecastService) DescribeWhatIfForecastExport(input *DescribeWhatIfForecastExportInput) (*DescribeWhatIfForecastExportOutput, error) { + req, out := c.DescribeWhatIfForecastExportRequest(input) + return out, req.Send() +} + +// DescribeWhatIfForecastExportWithContext is the same as DescribeWhatIfForecastExport with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeWhatIfForecastExport 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) DescribeWhatIfForecastExportWithContext(ctx aws.Context, input *DescribeWhatIfForecastExportInput, opts ...request.Option) (*DescribeWhatIfForecastExportOutput, error) { + req, out := c.DescribeWhatIfForecastExportRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetAccuracyMetrics = "GetAccuracyMetrics" + +// GetAccuracyMetricsRequest generates a "aws/request.Request" representing the +// client's request for the GetAccuracyMetrics 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 GetAccuracyMetrics for more information on using the GetAccuracyMetrics +// 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 GetAccuracyMetricsRequest method. +// req, resp := client.GetAccuracyMetricsRequest(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/GetAccuracyMetrics +func (c *ForecastService) GetAccuracyMetricsRequest(input *GetAccuracyMetricsInput) (req *request.Request, output *GetAccuracyMetricsOutput) { + op := &request.Operation{ + Name: opGetAccuracyMetrics, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &GetAccuracyMetricsInput{} + } + + output = &GetAccuracyMetricsOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetAccuracyMetrics API operation for Amazon Forecast Service. +// +// 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 (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html). +// +// 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. +// +// 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 GetAccuracyMetrics 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/GetAccuracyMetrics func (c *ForecastService) GetAccuracyMetrics(input *GetAccuracyMetricsInput) (*GetAccuracyMetricsOutput, error) { @@ -5154,437 +6039,601 @@ func (c *ForecastService) ListTagsForResourceWithContext(ctx aws.Context, input return out, req.Send() } -const opResumeResource = "ResumeResource" +const opListWhatIfAnalyses = "ListWhatIfAnalyses" -// ResumeResourceRequest generates a "aws/request.Request" representing the -// client's request for the ResumeResource operation. The "output" return +// ListWhatIfAnalysesRequest generates a "aws/request.Request" representing the +// client's request for the ListWhatIfAnalyses 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 ResumeResource for more information on using the ResumeResource +// See ListWhatIfAnalyses for more information on using the ListWhatIfAnalyses // 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 ResumeResourceRequest method. -// req, resp := client.ResumeResourceRequest(params) +// // Example sending a request using the ListWhatIfAnalysesRequest method. +// req, resp := client.ListWhatIfAnalysesRequest(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/ResumeResource -func (c *ForecastService) ResumeResourceRequest(input *ResumeResourceInput) (req *request.Request, output *ResumeResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfAnalyses +func (c *ForecastService) ListWhatIfAnalysesRequest(input *ListWhatIfAnalysesInput) (req *request.Request, output *ListWhatIfAnalysesOutput) { op := &request.Operation{ - Name: opResumeResource, + Name: opListWhatIfAnalyses, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } - if input == nil { - input = &ResumeResourceInput{} - } - - output = &ResumeResourceOutput{} + if input == nil { + input = &ListWhatIfAnalysesInput{} + } + + output = &ListWhatIfAnalysesOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// ResumeResource API operation for Amazon Forecast Service. +// ListWhatIfAnalyses API operation for Amazon Forecast Service. // -// Resumes a stopped monitor resource. +// Returns a list of what-if analyses created using the CreateWhatIfAnalysis +// operation. For each what-if analysis, 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 what-if analysis ARN with the +// DescribeWhatIfAnalysis 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 ResumeResource for usage and error information. +// API operation ListWhatIfAnalyses 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. // -// - LimitExceededException -// The limit on the number of resources per account has been exceeded. -// -// - 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/ResumeResource -func (c *ForecastService) ResumeResource(input *ResumeResourceInput) (*ResumeResourceOutput, error) { - req, out := c.ResumeResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfAnalyses +func (c *ForecastService) ListWhatIfAnalyses(input *ListWhatIfAnalysesInput) (*ListWhatIfAnalysesOutput, error) { + req, out := c.ListWhatIfAnalysesRequest(input) return out, req.Send() } -// ResumeResourceWithContext is the same as ResumeResource with the addition of +// ListWhatIfAnalysesWithContext is the same as ListWhatIfAnalyses with the addition of // the ability to pass a context and additional request options. // -// See ResumeResource for details on how to use this API operation. +// See ListWhatIfAnalyses 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) ResumeResourceWithContext(ctx aws.Context, input *ResumeResourceInput, opts ...request.Option) (*ResumeResourceOutput, error) { - req, out := c.ResumeResourceRequest(input) +func (c *ForecastService) ListWhatIfAnalysesWithContext(ctx aws.Context, input *ListWhatIfAnalysesInput, opts ...request.Option) (*ListWhatIfAnalysesOutput, error) { + req, out := c.ListWhatIfAnalysesRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStopResource = "StopResource" +// ListWhatIfAnalysesPages iterates over the pages of a ListWhatIfAnalyses operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListWhatIfAnalyses 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 ListWhatIfAnalyses operation. +// pageNum := 0 +// err := client.ListWhatIfAnalysesPages(params, +// func(page *forecastservice.ListWhatIfAnalysesOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *ForecastService) ListWhatIfAnalysesPages(input *ListWhatIfAnalysesInput, fn func(*ListWhatIfAnalysesOutput, bool) bool) error { + return c.ListWhatIfAnalysesPagesWithContext(aws.BackgroundContext(), input, fn) +} -// StopResourceRequest generates a "aws/request.Request" representing the -// client's request for the StopResource operation. The "output" return +// ListWhatIfAnalysesPagesWithContext same as ListWhatIfAnalysesPages 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) ListWhatIfAnalysesPagesWithContext(ctx aws.Context, input *ListWhatIfAnalysesInput, fn func(*ListWhatIfAnalysesOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListWhatIfAnalysesInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListWhatIfAnalysesRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListWhatIfAnalysesOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListWhatIfForecastExports = "ListWhatIfForecastExports" + +// ListWhatIfForecastExportsRequest generates a "aws/request.Request" representing the +// client's request for the ListWhatIfForecastExports 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 StopResource for more information on using the StopResource +// See ListWhatIfForecastExports for more information on using the ListWhatIfForecastExports // 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 StopResourceRequest method. -// req, resp := client.StopResourceRequest(params) +// // Example sending a request using the ListWhatIfForecastExportsRequest method. +// req, resp := client.ListWhatIfForecastExportsRequest(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/StopResource -func (c *ForecastService) StopResourceRequest(input *StopResourceInput) (req *request.Request, output *StopResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfForecastExports +func (c *ForecastService) ListWhatIfForecastExportsRequest(input *ListWhatIfForecastExportsInput) (req *request.Request, output *ListWhatIfForecastExportsOutput) { op := &request.Operation{ - Name: opStopResource, + Name: opListWhatIfForecastExports, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } if input == nil { - input = &StopResourceInput{} + input = &ListWhatIfForecastExportsInput{} } - output = &StopResourceOutput{} + output = &ListWhatIfForecastExportsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// StopResource API operation for Amazon Forecast Service. -// -// Stops a resource. -// -// The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED. -// You cannot resume a resource once it has been stopped. -// -// This operation can be applied to the following resources (and their corresponding -// child resources): -// -// - Dataset Import Job -// -// - Predictor Job -// -// - Forecast Job -// -// - Forecast Export Job -// -// - Predictor Backtest Export Job -// -// - Explainability Job +// ListWhatIfForecastExports API operation for Amazon Forecast Service. // -// - Explainability Export Job +// Returns a list of what-if forecast exports created using the CreateWhatIfForecastExport +// operation. For each what-if forecast export, 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 what-if forecast export ARN with +// the DescribeWhatIfForecastExport 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 StopResource for usage and error information. +// API operation ListWhatIfForecastExports 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. // -// - LimitExceededException -// The limit on the number of resources per account has been exceeded. -// -// - 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/StopResource -func (c *ForecastService) StopResource(input *StopResourceInput) (*StopResourceOutput, error) { - req, out := c.StopResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfForecastExports +func (c *ForecastService) ListWhatIfForecastExports(input *ListWhatIfForecastExportsInput) (*ListWhatIfForecastExportsOutput, error) { + req, out := c.ListWhatIfForecastExportsRequest(input) return out, req.Send() } -// StopResourceWithContext is the same as StopResource with the addition of +// ListWhatIfForecastExportsWithContext is the same as ListWhatIfForecastExports with the addition of // the ability to pass a context and additional request options. // -// See StopResource for details on how to use this API operation. +// See ListWhatIfForecastExports 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) StopResourceWithContext(ctx aws.Context, input *StopResourceInput, opts ...request.Option) (*StopResourceOutput, error) { - req, out := c.StopResourceRequest(input) +func (c *ForecastService) ListWhatIfForecastExportsWithContext(ctx aws.Context, input *ListWhatIfForecastExportsInput, opts ...request.Option) (*ListWhatIfForecastExportsOutput, error) { + req, out := c.ListWhatIfForecastExportsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opTagResource = "TagResource" +// ListWhatIfForecastExportsPages iterates over the pages of a ListWhatIfForecastExports operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListWhatIfForecastExports 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 ListWhatIfForecastExports operation. +// pageNum := 0 +// err := client.ListWhatIfForecastExportsPages(params, +// func(page *forecastservice.ListWhatIfForecastExportsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *ForecastService) ListWhatIfForecastExportsPages(input *ListWhatIfForecastExportsInput, fn func(*ListWhatIfForecastExportsOutput, bool) bool) error { + return c.ListWhatIfForecastExportsPagesWithContext(aws.BackgroundContext(), input, fn) +} -// TagResourceRequest generates a "aws/request.Request" representing the -// client's request for the TagResource operation. The "output" return +// ListWhatIfForecastExportsPagesWithContext same as ListWhatIfForecastExportsPages 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) ListWhatIfForecastExportsPagesWithContext(ctx aws.Context, input *ListWhatIfForecastExportsInput, fn func(*ListWhatIfForecastExportsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListWhatIfForecastExportsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListWhatIfForecastExportsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListWhatIfForecastExportsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListWhatIfForecasts = "ListWhatIfForecasts" + +// ListWhatIfForecastsRequest generates a "aws/request.Request" representing the +// client's request for the ListWhatIfForecasts 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 ListWhatIfForecasts for more information on using the ListWhatIfForecasts // 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 ListWhatIfForecastsRequest method. +// req, resp := client.ListWhatIfForecastsRequest(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/TagResource -func (c *ForecastService) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfForecasts +func (c *ForecastService) ListWhatIfForecastsRequest(input *ListWhatIfForecastsInput) (req *request.Request, output *ListWhatIfForecastsOutput) { op := &request.Operation{ - Name: opTagResource, + Name: opListWhatIfForecasts, HTTPMethod: "POST", HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, } if input == nil { - input = &TagResourceInput{} + input = &ListWhatIfForecastsInput{} } - output = &TagResourceOutput{} + output = &ListWhatIfForecastsOutput{} req = c.newRequest(op, input, output) - req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// TagResource API operation for Amazon Forecast Service. +// ListWhatIfForecasts API operation for Amazon Forecast Service. // -// Associates the specified tags to a resource with the specified resourceArn. -// If existing tags on a resource are not specified in the request parameters, -// they are not changed. When a resource is deleted, the tags associated with -// that resource are also deleted. +// Returns a list of what-if forecasts created using the CreateWhatIfForecast +// operation. For each what-if forecast, 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 what-if forecast ARN with the +// DescribeWhatIfForecast 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 TagResource for usage and error information. +// API operation ListWhatIfForecasts for usage and error information. // // Returned Error Types: // -// - ResourceNotFoundException -// We can't find a resource with that Amazon Resource Name (ARN). Check the -// ARN and try again. -// -// - LimitExceededException -// The limit on the number of resources per account has been exceeded. +// - 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/TagResource -func (c *ForecastService) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ListWhatIfForecasts +func (c *ForecastService) ListWhatIfForecasts(input *ListWhatIfForecastsInput) (*ListWhatIfForecastsOutput, error) { + req, out := c.ListWhatIfForecastsRequest(input) return out, req.Send() } -// TagResourceWithContext is the same as TagResource with the addition of +// ListWhatIfForecastsWithContext is the same as ListWhatIfForecasts 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 ListWhatIfForecasts 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) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { - req, out := c.TagResourceRequest(input) +func (c *ForecastService) ListWhatIfForecastsWithContext(ctx aws.Context, input *ListWhatIfForecastsInput, opts ...request.Option) (*ListWhatIfForecastsOutput, error) { + req, out := c.ListWhatIfForecastsRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUntagResource = "UntagResource" +// ListWhatIfForecastsPages iterates over the pages of a ListWhatIfForecasts operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListWhatIfForecasts 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 ListWhatIfForecasts operation. +// pageNum := 0 +// err := client.ListWhatIfForecastsPages(params, +// func(page *forecastservice.ListWhatIfForecastsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *ForecastService) ListWhatIfForecastsPages(input *ListWhatIfForecastsInput, fn func(*ListWhatIfForecastsOutput, bool) bool) error { + return c.ListWhatIfForecastsPagesWithContext(aws.BackgroundContext(), input, fn) +} -// UntagResourceRequest generates a "aws/request.Request" representing the -// client's request for the UntagResource operation. The "output" return +// ListWhatIfForecastsPagesWithContext same as ListWhatIfForecastsPages 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) ListWhatIfForecastsPagesWithContext(ctx aws.Context, input *ListWhatIfForecastsInput, fn func(*ListWhatIfForecastsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListWhatIfForecastsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListWhatIfForecastsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListWhatIfForecastsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opResumeResource = "ResumeResource" + +// ResumeResourceRequest generates a "aws/request.Request" representing the +// client's request for the ResumeResource 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 ResumeResource for more information on using the ResumeResource // 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 ResumeResourceRequest method. +// req, resp := client.ResumeResourceRequest(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/UntagResource -func (c *ForecastService) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ResumeResource +func (c *ForecastService) ResumeResourceRequest(input *ResumeResourceInput) (req *request.Request, output *ResumeResourceOutput) { op := &request.Operation{ - Name: opUntagResource, + Name: opResumeResource, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UntagResourceInput{} + input = &ResumeResourceInput{} } - output = &UntagResourceOutput{} + output = &ResumeResourceOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UntagResource API operation for Amazon Forecast Service. +// ResumeResource API operation for Amazon Forecast Service. // -// Deletes the specified tags from a resource. +// Resumes a stopped monitor 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 // the error. // // See the AWS API reference guide for Amazon Forecast Service's -// API operation UntagResource for usage and error information. +// API operation ResumeResource 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. +// +// - LimitExceededException +// The limit on the number of resources per account has been exceeded. +// // - ResourceNotFoundException // We can't find a resource with that Amazon Resource Name (ARN). Check the // ARN and try again. // -// - InvalidInputException -// We can't process the request because it includes an invalid value or a value -// that exceeds the valid range. +// - ResourceInUseException +// The specified resource is in use. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UntagResource -func (c *ForecastService) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/ResumeResource +func (c *ForecastService) ResumeResource(input *ResumeResourceInput) (*ResumeResourceOutput, error) { + req, out := c.ResumeResourceRequest(input) return out, req.Send() } -// UntagResourceWithContext is the same as UntagResource with the addition of +// ResumeResourceWithContext is the same as ResumeResource 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 ResumeResource 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) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { - req, out := c.UntagResourceRequest(input) +func (c *ForecastService) ResumeResourceWithContext(ctx aws.Context, input *ResumeResourceInput, opts ...request.Option) (*ResumeResourceOutput, error) { + req, out := c.ResumeResourceRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opUpdateDatasetGroup = "UpdateDatasetGroup" +const opStopResource = "StopResource" -// UpdateDatasetGroupRequest generates a "aws/request.Request" representing the -// client's request for the UpdateDatasetGroup operation. The "output" return +// StopResourceRequest generates a "aws/request.Request" representing the +// client's request for the StopResource 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 UpdateDatasetGroup for more information on using the UpdateDatasetGroup +// See StopResource for more information on using the StopResource // 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 UpdateDatasetGroupRequest method. -// req, resp := client.UpdateDatasetGroupRequest(params) +// // Example sending a request using the StopResourceRequest method. +// req, resp := client.StopResourceRequest(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/UpdateDatasetGroup -func (c *ForecastService) UpdateDatasetGroupRequest(input *UpdateDatasetGroupInput) (req *request.Request, output *UpdateDatasetGroupOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/StopResource +func (c *ForecastService) StopResourceRequest(input *StopResourceInput) (req *request.Request, output *StopResourceOutput) { op := &request.Operation{ - Name: opUpdateDatasetGroup, + Name: opStopResource, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &UpdateDatasetGroupInput{} + input = &StopResourceInput{} } - output = &UpdateDatasetGroupOutput{} + output = &StopResourceOutput{} req = c.newRequest(op, input, output) req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) return } -// UpdateDatasetGroup API operation for Amazon Forecast Service. +// StopResource API operation for Amazon Forecast Service. // -// Replaces the datasets in a dataset group with the specified datasets. +// Stops a resource. // -// The Status of the dataset group must be ACTIVE before you can use the dataset -// group to create a predictor. Use the DescribeDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) -// operation to get the status. +// The resource undergoes the following states: CREATE_STOPPING and CREATE_STOPPED. +// You cannot resume a resource once it has been stopped. +// +// This operation can be applied to the following resources (and their corresponding +// child resources): +// +// - Dataset Import Job +// +// - Predictor Job +// +// - Forecast Job +// +// - Forecast Export Job +// +// - Predictor Backtest Export Job +// +// - Explainability Job +// +// - 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 UpdateDatasetGroup for usage and error information. +// API operation StopResource for usage and error information. // // Returned Error Types: // @@ -5592,62 +6641,421 @@ func (c *ForecastService) UpdateDatasetGroupRequest(input *UpdateDatasetGroupInp // We can't process the request because it includes an invalid value or a value // that exceeds the valid range. // +// - LimitExceededException +// The limit on the number of resources per account has been exceeded. +// // - 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/StopResource +func (c *ForecastService) StopResource(input *StopResourceInput) (*StopResourceOutput, error) { + req, out := c.StopResourceRequest(input) + return out, req.Send() +} + +// StopResourceWithContext is the same as StopResource with the addition of +// the ability to pass a context and additional request options. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/UpdateDatasetGroup -func (c *ForecastService) UpdateDatasetGroup(input *UpdateDatasetGroupInput) (*UpdateDatasetGroupOutput, error) { - req, out := c.UpdateDatasetGroupRequest(input) +// See StopResource 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) StopResourceWithContext(ctx aws.Context, input *StopResourceInput, opts ...request.Option) (*StopResourceOutput, error) { + req, out := c.StopResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) return out, req.Send() } -// UpdateDatasetGroupWithContext is the same as UpdateDatasetGroup with the addition of +const opTagResource = "TagResource" + +// 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 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 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/forecast-2018-06-26/TagResource +func (c *ForecastService) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { + op := &request.Operation{ + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &TagResourceInput{} + } + + output = &TagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// TagResource API operation for Amazon Forecast Service. +// +// Associates the specified tags to a resource with the specified resourceArn. +// If existing tags on a resource are not specified in the request parameters, +// they are not changed. When a resource is deleted, the tags associated with +// that resource are also deleted. +// +// 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 TagResource for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// We can't find a resource with that Amazon Resource Name (ARN). Check the +// ARN and try again. +// +// - LimitExceededException +// The limit on the number of resources per account has been exceeded. +// +// - 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/TagResource +func (c *ForecastService) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + return out, req.Send() +} + +// TagResourceWithContext is the same as TagResource with the addition of // the ability to pass a context and additional request options. // -// See UpdateDatasetGroup 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 *ForecastService) UpdateDatasetGroupWithContext(ctx aws.Context, input *UpdateDatasetGroupInput, opts ...request.Option) (*UpdateDatasetGroupOutput, error) { - req, out := c.UpdateDatasetGroupRequest(input) +func (c *ForecastService) 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() } -// Describes an additional dataset. This object is part of the DataConfig object. -// Forecast supports the Weather Index and Holidays additional datasets. +const opUntagResource = "UntagResource" + +// 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. // -// # Weather Index +// 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. // -// 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). +// See UntagResource for more information on using the UntagResource +// API call, and error handling. // -// # Holidays +// 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. // -// 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"` +// // 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/forecast-2018-06-26/UntagResource +func (c *ForecastService) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "POST", + HTTPPath: "/", + } - // Weather Index - // - // To enable the Weather Index, do not specify a value for Configuration. - // - // Holidays - // - // Holidays + if input == nil { + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UntagResource API operation for Amazon Forecast Service. +// +// Deletes the specified tags from a 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 +// the error. +// +// See the AWS API reference guide for Amazon Forecast Service's +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// We can't find a resource with that Amazon Resource Name (ARN). Check the +// ARN and try again. +// +// - 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/UntagResource +func (c *ForecastService) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource 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. +// +// 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) 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 opUpdateDatasetGroup = "UpdateDatasetGroup" + +// UpdateDatasetGroupRequest generates a "aws/request.Request" representing the +// client's request for the UpdateDatasetGroup 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 UpdateDatasetGroup for more information on using the UpdateDatasetGroup +// 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 UpdateDatasetGroupRequest method. +// req, resp := client.UpdateDatasetGroupRequest(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/UpdateDatasetGroup +func (c *ForecastService) UpdateDatasetGroupRequest(input *UpdateDatasetGroupInput) (req *request.Request, output *UpdateDatasetGroupOutput) { + op := &request.Operation{ + Name: opUpdateDatasetGroup, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateDatasetGroupInput{} + } + + output = &UpdateDatasetGroupOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UpdateDatasetGroup API operation for Amazon Forecast Service. +// +// 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 (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) +// operation to get the status. +// +// 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 UpdateDatasetGroup 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/UpdateDatasetGroup +func (c *ForecastService) UpdateDatasetGroup(input *UpdateDatasetGroupInput) (*UpdateDatasetGroupOutput, error) { + req, out := c.UpdateDatasetGroupRequest(input) + return out, req.Send() +} + +// UpdateDatasetGroupWithContext is the same as UpdateDatasetGroup with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateDatasetGroup 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) UpdateDatasetGroupWithContext(ctx aws.Context, input *UpdateDatasetGroupInput, opts ...request.Option) (*UpdateDatasetGroupOutput, error) { + req, out := c.UpdateDatasetGroupRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// Defines the modifications that you are making to an attribute for a what-if +// forecast. For example, you can use this operation to create a what-if forecast +// that investigates a 10% off sale on all shoes. To do this, you specify "AttributeName": +// "shoes", "Operation": "MULTIPLY", and "Value": "0.90". Pair this operation +// with the TimeSeriesCondition operation within the CreateWhatIfForecastRequest$TimeSeriesTransformations +// operation to define a subset of attribute items that are modified. +type Action struct { + _ struct{} `type:"structure"` + + // The related time series that you are modifying. This value is case insensitive. + // + // AttributeName is a required field + AttributeName *string `min:"1" type:"string" required:"true"` + + // The operation that is applied to the provided attribute. Operations include: + // + // * ADD - adds Value to all rows of AttributeName. + // + // * SUBTRACT - subtracts Value from all rows of AttributeName. + // + // * MULTIPLY - multiplies all rows of AttributeName by Value. + // + // * DIVIDE - divides all rows of AttributeName by Value. + // + // Operation is a required field + Operation *string `type:"string" required:"true" enum:"Operation"` + + // The value that is applied for the chosen Operation. + // + // 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 Action) 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 Action) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Action) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Action"} + if s.AttributeName == nil { + invalidParams.Add(request.NewErrParamRequired("AttributeName")) + } + if s.AttributeName != nil && len(*s.AttributeName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AttributeName", 1)) + } + if s.Operation == nil { + invalidParams.Add(request.NewErrParamRequired("Operation")) + } + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAttributeName sets the AttributeName field's value. +func (s *Action) SetAttributeName(v string) *Action { + s.AttributeName = &v + return s +} + +// SetOperation sets the Operation field's value. +func (s *Action) SetOperation(v string) *Action { + s.Operation = &v + return s +} + +// SetValue sets the Value field's value. +func (s *Action) SetValue(v float64) *Action { + s.Value = &v + return s +} + +// 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"` + + // Weather Index + // + // To enable the Weather Index, do not specify a value for Configuration. + // + // Holidays + // + // Holidays // // To enable Holidays, set CountryCode to one of the following two-letter country // codes: @@ -8509,28 +9917,43 @@ func (s *CreatePredictorOutput) SetPredictorArn(v string) *CreatePredictorOutput return s } -// The data configuration for your dataset group and any additional datasets. -type DataConfig struct { +type CreateWhatIfAnalysisInput struct { _ struct{} `type:"structure"` - // Additional built-in datasets like Holidays and the Weather Index. - AdditionalDatasets []*AdditionalDataset `min:"1" type:"list"` + // The Amazon Resource Name (ARN) of the baseline forecast. + // + // ForecastArn is a required field + ForecastArn *string `type:"string" required:"true"` - // Aggregation and filling options for attributes in your dataset group. - AttributeConfigs []*AttributeConfig `min:"1" type:"list"` + // A list of tags (https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) + // to apply to the what if forecast. + Tags []*Tag `type:"list"` - // The ARN of the dataset group used to train the predictor. + // Defines the set of time series that are used in the what-if analysis with + // a TimeSeriesIdentifiers object. What-if analyses are performed only for the + // time series in this object. // - // 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 { + // The TimeSeriesIdentifiers object needs the following information: + // + // * DataSource + // + // * Format + // + // * Schema + TimeSeriesSelector *TimeSeriesSelector `type:"structure"` + + // The name of the what-if analysis. Each name must be unique. + // + // WhatIfAnalysisName is a required field + WhatIfAnalysisName *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 CreateWhatIfAnalysisInput) String() string { return awsutil.Prettify(s) } @@ -8539,40 +9962,35 @@ func (s DataConfig) 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 DataConfig) GoString() string { +func (s CreateWhatIfAnalysisInput) 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)) +func (s *CreateWhatIfAnalysisInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateWhatIfAnalysisInput"} + if s.ForecastArn == nil { + invalidParams.Add(request.NewErrParamRequired("ForecastArn")) } - if s.AttributeConfigs != nil && len(s.AttributeConfigs) < 1 { - invalidParams.Add(request.NewErrParamMinLen("AttributeConfigs", 1)) + if s.WhatIfAnalysisName == nil { + invalidParams.Add(request.NewErrParamRequired("WhatIfAnalysisName")) } - if s.DatasetGroupArn == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn")) + if s.WhatIfAnalysisName != nil && len(*s.WhatIfAnalysisName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("WhatIfAnalysisName", 1)) } - if s.AdditionalDatasets != nil { - for i, v := range s.AdditionalDatasets { + 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]", "AdditionalDatasets", i), err.(request.ErrInvalidParams)) + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", 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 s.TimeSeriesSelector != nil { + if err := s.TimeSeriesSelector.Validate(); err != nil { + invalidParams.AddNested("TimeSeriesSelector", err.(request.ErrInvalidParams)) } } @@ -8582,35 +10000,35 @@ func (s *DataConfig) Validate() error { return nil } -// SetAdditionalDatasets sets the AdditionalDatasets field's value. -func (s *DataConfig) SetAdditionalDatasets(v []*AdditionalDataset) *DataConfig { - s.AdditionalDatasets = v +// SetForecastArn sets the ForecastArn field's value. +func (s *CreateWhatIfAnalysisInput) SetForecastArn(v string) *CreateWhatIfAnalysisInput { + s.ForecastArn = &v return s } -// SetAttributeConfigs sets the AttributeConfigs field's value. -func (s *DataConfig) SetAttributeConfigs(v []*AttributeConfig) *DataConfig { - s.AttributeConfigs = v +// SetTags sets the Tags field's value. +func (s *CreateWhatIfAnalysisInput) SetTags(v []*Tag) *CreateWhatIfAnalysisInput { + s.Tags = v return s } -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *DataConfig) SetDatasetGroupArn(v string) *DataConfig { - s.DatasetGroupArn = &v +// SetTimeSeriesSelector sets the TimeSeriesSelector field's value. +func (s *CreateWhatIfAnalysisInput) SetTimeSeriesSelector(v *TimeSeriesSelector) *CreateWhatIfAnalysisInput { + s.TimeSeriesSelector = 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 { +// SetWhatIfAnalysisName sets the WhatIfAnalysisName field's value. +func (s *CreateWhatIfAnalysisInput) SetWhatIfAnalysisName(v string) *CreateWhatIfAnalysisInput { + s.WhatIfAnalysisName = &v + return s +} + +type CreateWhatIfAnalysisOutput 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"` + // The Amazon Resource Name (ARN) of the what-if analysis. + WhatIfAnalysisArn *string `type:"string"` } // String returns the string representation. @@ -8618,7 +10036,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 CreateWhatIfAnalysisOutput) String() string { return awsutil.Prettify(s) } @@ -8627,45 +10045,46 @@ 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 CreateWhatIfAnalysisOutput) 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 +// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value. +func (s *CreateWhatIfAnalysisOutput) SetWhatIfAnalysisArn(v string) *CreateWhatIfAnalysisOutput { + s.WhatIfAnalysisArn = &v return s } -// The source of your 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. -type DataSource struct { +type CreateWhatIfForecastExportInput struct { _ struct{} `type:"structure"` - // The path to the data stored in an Amazon Simple Storage Service (Amazon S3) - // bucket along with the credentials to access the data. + // 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. // - // S3Config is a required field - S3Config *S3Config `type:"structure" 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 format of the exported data, CSV or PARQUET. + Format *string `type:"string"` + + // A list of tags (https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) + // to apply to the what if forecast. + Tags []*Tag `type:"list"` + + // The list of what-if forecast Amazon Resource Names (ARNs) to export. + // + // WhatIfForecastArns is a required field + WhatIfForecastArns []*string `min:"1" type:"list" required:"true"` + + // The name of the what-if forecast to export. + // + // WhatIfForecastExportName is a required field + WhatIfForecastExportName *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -8673,7 +10092,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 CreateWhatIfForecastExportInput) String() string { return awsutil.Prettify(s) } @@ -8682,19 +10101,41 @@ 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 CreateWhatIfForecastExportInput) 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")) +func (s *CreateWhatIfForecastExportInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateWhatIfForecastExportInput"} + if s.Destination == nil { + invalidParams.Add(request.NewErrParamRequired("Destination")) } - if s.S3Config != nil { - if err := s.S3Config.Validate(); err != nil { - invalidParams.AddNested("S3Config", err.(request.ErrInvalidParams)) + if s.WhatIfForecastArns == nil { + invalidParams.Add(request.NewErrParamRequired("WhatIfForecastArns")) + } + if s.WhatIfForecastArns != nil && len(s.WhatIfForecastArns) < 1 { + invalidParams.Add(request.NewErrParamMinLen("WhatIfForecastArns", 1)) + } + if s.WhatIfForecastExportName == nil { + invalidParams.Add(request.NewErrParamRequired("WhatIfForecastExportName")) + } + if s.WhatIfForecastExportName != nil && len(*s.WhatIfForecastExportName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("WhatIfForecastExportName", 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)) + } } } @@ -8704,34 +10145,41 @@ func (s *DataSource) Validate() error { return nil } -// SetS3Config sets the S3Config field's value. -func (s *DataSource) SetS3Config(v *S3Config) *DataSource { - s.S3Config = v +// SetDestination sets the Destination field's value. +func (s *CreateWhatIfForecastExportInput) SetDestination(v *DataDestination) *CreateWhatIfForecastExportInput { + s.Destination = v return s } -// Provides a summary of the dataset group properties used in the ListDatasetGroups -// (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html) -// operation. To get the complete set of properties, call the DescribeDatasetGroup -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) -// operation, and provide the DatasetGroupArn. -type DatasetGroupSummary struct { - _ struct{} `type:"structure"` +// SetFormat sets the Format field's value. +func (s *CreateWhatIfForecastExportInput) SetFormat(v string) *CreateWhatIfForecastExportInput { + s.Format = &v + return s +} - // When the dataset group was created. - CreationTime *time.Time `type:"timestamp"` +// SetTags sets the Tags field's value. +func (s *CreateWhatIfForecastExportInput) SetTags(v []*Tag) *CreateWhatIfForecastExportInput { + s.Tags = v + return s +} - // The Amazon Resource Name (ARN) of the dataset group. - DatasetGroupArn *string `type:"string"` +// SetWhatIfForecastArns sets the WhatIfForecastArns field's value. +func (s *CreateWhatIfForecastExportInput) SetWhatIfForecastArns(v []*string) *CreateWhatIfForecastExportInput { + s.WhatIfForecastArns = v + return s +} - // The name of the dataset group. - DatasetGroupName *string `min:"1" type:"string"` +// SetWhatIfForecastExportName sets the WhatIfForecastExportName field's value. +func (s *CreateWhatIfForecastExportInput) SetWhatIfForecastExportName(v string) *CreateWhatIfForecastExportInput { + s.WhatIfForecastExportName = &v + return s +} - // When the dataset group was created or last updated from a call to the UpdateDatasetGroup - // (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) - // operation. While the dataset group is being updated, LastModificationTime - // is the current time of the ListDatasetGroups call. - LastModificationTime *time.Time `type:"timestamp"` +type CreateWhatIfForecastExportOutput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the what-if forecast. + WhatIfForecastExportArn *string `type:"string"` } // String returns the string representation. @@ -8739,7 +10187,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 CreateWhatIfForecastExportOutput) String() string { return awsutil.Prettify(s) } @@ -8748,176 +10196,154 @@ 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 CreateWhatIfForecastExportOutput) 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 +// SetWhatIfForecastExportArn sets the WhatIfForecastExportArn field's value. +func (s *CreateWhatIfForecastExportOutput) SetWhatIfForecastExportArn(v string) *CreateWhatIfForecastExportOutput { + s.WhatIfForecastExportArn = &v return s } -// Provides a summary of the dataset import job properties used in the ListDatasetImportJobs -// (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html) -// operation. To get the complete set of properties, call the DescribeDatasetImportJob -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) -// operation, and provide the DatasetImportJobArn. -type DatasetImportJobSummary struct { +type CreateWhatIfForecastInput struct { _ struct{} `type:"structure"` - // When the dataset import job was created. - CreationTime *time.Time `type:"timestamp"` + // A list of tags (https://docs.aws.amazon.com/forecast/latest/dg/tagging-forecast-resources.html) + // to apply to the what if forecast. + Tags []*Tag `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 replacement time series dataset, which contains the rows that you want + // to change in the related time series dataset. A replacement time series does + // not need to contain all rows that are in the baseline related time series. + // Include only the rows (measure-dimension combinations) that you want to include + // in the what-if forecast. This dataset is merged with the original time series + // to create a transformed dataset that is used for the what-if analysis. // - // 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"` + // This dataset should contain the items to modify (such as item_id or workforce_type), + // any relevant dimensions, the timestamp column, and at least one of the related + // time series columns. This file should not contain duplicate timestamps for + // the same time series. + // + // Timestamps and item_ids not included in this dataset are not included in + // the what-if analysis. + TimeSeriesReplacementsDataSource *TimeSeriesReplacementsDataSource `type:"structure"` - // The name of the dataset import job. - DatasetImportJobName *string `min:"1" type:"string"` + // The transformations that are applied to the baseline time series. Each transformation + // contains an action and a set of conditions. An action is applied only when + // all conditions are met. If no conditions are provided, the action is applied + // to all items. + TimeSeriesTransformations []*TimeSeriesTransformation `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. + // The Amazon Resource Name (ARN) of the what-if analysis. // - // * CREATE_STOPPED - When the job stopped. + // WhatIfAnalysisArn is a required field + WhatIfAnalysisArn *string `type:"string" required:"true"` + + // The name of the what-if forecast. Names must be unique within each what-if + // analysis. // - // * ACTIVE or CREATE_FAILED - When the job finished or failed. - LastModificationTime *time.Time `type:"timestamp"` + // WhatIfForecastName is a required field + WhatIfForecastName *string `min:"1" type:"string" required:"true"` +} - // 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) -} +// 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 CreateWhatIfForecastInput) 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 { +func (s CreateWhatIfForecastInput) 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 -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateWhatIfForecastInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateWhatIfForecastInput"} + if s.WhatIfAnalysisArn == nil { + invalidParams.Add(request.NewErrParamRequired("WhatIfAnalysisArn")) + } + if s.WhatIfForecastName == nil { + invalidParams.Add(request.NewErrParamRequired("WhatIfForecastName")) + } + if s.WhatIfForecastName != nil && len(*s.WhatIfForecastName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("WhatIfForecastName", 1)) + } + 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.TimeSeriesReplacementsDataSource != nil { + if err := s.TimeSeriesReplacementsDataSource.Validate(); err != nil { + invalidParams.AddNested("TimeSeriesReplacementsDataSource", err.(request.ErrInvalidParams)) + } + } + if s.TimeSeriesTransformations != nil { + for i, v := range s.TimeSeriesTransformations { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "TimeSeriesTransformations", i), err.(request.ErrInvalidParams)) + } + } + } -// SetDataSource sets the DataSource field's value. -func (s *DatasetImportJobSummary) SetDataSource(v *DataSource) *DatasetImportJobSummary { - s.DataSource = v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. -func (s *DatasetImportJobSummary) SetDatasetImportJobArn(v string) *DatasetImportJobSummary { - s.DatasetImportJobArn = &v +// SetTags sets the Tags field's value. +func (s *CreateWhatIfForecastInput) SetTags(v []*Tag) *CreateWhatIfForecastInput { + s.Tags = v return s } -// SetDatasetImportJobName sets the DatasetImportJobName field's value. -func (s *DatasetImportJobSummary) SetDatasetImportJobName(v string) *DatasetImportJobSummary { - s.DatasetImportJobName = &v +// SetTimeSeriesReplacementsDataSource sets the TimeSeriesReplacementsDataSource field's value. +func (s *CreateWhatIfForecastInput) SetTimeSeriesReplacementsDataSource(v *TimeSeriesReplacementsDataSource) *CreateWhatIfForecastInput { + s.TimeSeriesReplacementsDataSource = v return s } -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *DatasetImportJobSummary) SetLastModificationTime(v time.Time) *DatasetImportJobSummary { - s.LastModificationTime = &v +// SetTimeSeriesTransformations sets the TimeSeriesTransformations field's value. +func (s *CreateWhatIfForecastInput) SetTimeSeriesTransformations(v []*TimeSeriesTransformation) *CreateWhatIfForecastInput { + s.TimeSeriesTransformations = v return s } -// SetMessage sets the Message field's value. -func (s *DatasetImportJobSummary) SetMessage(v string) *DatasetImportJobSummary { - s.Message = &v +// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value. +func (s *CreateWhatIfForecastInput) SetWhatIfAnalysisArn(v string) *CreateWhatIfForecastInput { + s.WhatIfAnalysisArn = &v return s } -// SetStatus sets the Status field's value. -func (s *DatasetImportJobSummary) SetStatus(v string) *DatasetImportJobSummary { - s.Status = &v +// SetWhatIfForecastName sets the WhatIfForecastName field's value. +func (s *CreateWhatIfForecastInput) SetWhatIfForecastName(v string) *CreateWhatIfForecastInput { + s.WhatIfForecastName = &v return s } -// Provides a summary of the dataset properties used in the ListDatasets (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) -// operation. To get the complete set of properties, call the DescribeDataset -// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) -// operation, and provide the DatasetArn. -type DatasetSummary struct { +type CreateWhatIfForecastOutput 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 (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) - // operation has finished, LastModificationTime is when the import job completed - // or failed. - LastModificationTime *time.Time `type:"timestamp"` + // The Amazon Resource Name (ARN) of the what-if forecast. + WhatIfForecastArn *string `type:"string"` } // String returns the string representation. @@ -8925,7 +10351,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 CreateWhatIfForecastOutput) String() string { return awsutil.Prettify(s) } @@ -8934,50 +10360,27 @@ 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 CreateWhatIfForecastOutput) 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 +// SetWhatIfForecastArn sets the WhatIfForecastArn field's value. +func (s *CreateWhatIfForecastOutput) SetWhatIfForecastArn(v string) *CreateWhatIfForecastOutput { + s.WhatIfForecastArn = &v return s } -// SetDomain sets the Domain field's value. -func (s *DatasetSummary) SetDomain(v string) *DatasetSummary { - s.Domain = &v - return s -} +// The data configuration for your dataset group and any additional datasets. +type DataConfig struct { + _ struct{} `type:"structure"` -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *DatasetSummary) SetLastModificationTime(v time.Time) *DatasetSummary { - s.LastModificationTime = &v - return s -} + // Additional built-in datasets like Holidays and the Weather Index. + AdditionalDatasets []*AdditionalDataset `min:"1" type:"list"` -type DeleteDatasetGroupInput struct { - _ struct{} `type:"structure"` + // Aggregation and filling options for attributes in your dataset group. + AttributeConfigs []*AttributeConfig `min:"1" type:"list"` - // The Amazon Resource Name (ARN) of the dataset group to delete. + // The ARN of the dataset group used to train the predictor. // // DatasetGroupArn is a required field DatasetGroupArn *string `type:"string" required:"true"` @@ -8988,7 +10391,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 DataConfig) String() string { return awsutil.Prettify(s) } @@ -8997,16 +10400,42 @@ 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 DataConfig) 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"} +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 @@ -9014,41 +10443,35 @@ func (s *DeleteDatasetGroupInput) Validate() error { return nil } -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *DeleteDatasetGroupInput) SetDatasetGroupArn(v string) *DeleteDatasetGroupInput { - s.DatasetGroupArn = &v +// SetAdditionalDatasets sets the AdditionalDatasets field's value. +func (s *DataConfig) SetAdditionalDatasets(v []*AdditionalDataset) *DataConfig { + s.AdditionalDatasets = 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) +// SetAttributeConfigs sets the AttributeConfigs field's value. +func (s *DataConfig) SetAttributeConfigs(v []*AttributeConfig) *DataConfig { + s.AttributeConfigs = 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 DeleteDatasetGroupOutput) GoString() string { - return s.String() +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *DataConfig) SetDatasetGroupArn(v string) *DataConfig { + s.DatasetGroupArn = &v + return s } -type DeleteDatasetImportJobInput struct { +// 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 Amazon Resource Name (ARN) of the dataset import job to delete. + // The path to an Amazon Simple Storage Service (Amazon S3) bucket along with + // the credentials to access the bucket. // - // DatasetImportJobArn is a required field - DatasetImportJobArn *string `type:"string" required:"true"` + // S3Config is a required field + S3Config *S3Config `type:"structure" required:"true"` } // String returns the string representation. @@ -9056,7 +10479,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 DataDestination) String() string { return awsutil.Prettify(s) } @@ -9065,15 +10488,20 @@ 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 DataDestination) 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 *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 { @@ -9082,14 +10510,23 @@ func (s *DeleteDatasetImportJobInput) Validate() error { return nil } -// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. -func (s *DeleteDatasetImportJobInput) SetDatasetImportJobArn(v string) *DeleteDatasetImportJobInput { - s.DatasetImportJobArn = &v +// SetS3Config sets the S3Config field's value. +func (s *DataDestination) SetS3Config(v *S3Config) *DataDestination { + s.S3Config = v return s } -type DeleteDatasetImportJobOutput struct { +// The source of your 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. +type DataSource struct { _ struct{} `type:"structure"` + + // The path to the 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. @@ -9097,34 +10534,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 { - 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 DeleteDatasetImportJobOutput) GoString() string { - return s.String() -} - -type DeleteDatasetInput struct { - _ struct{} `type:"structure"` - - // The Amazon Resource Name (ARN) of the dataset to delete. - // - // DatasetArn is a required field - DatasetArn *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 DeleteDatasetInput) String() string { +func (s DataSource) String() string { return awsutil.Prettify(s) } @@ -9133,15 +10543,20 @@ 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 DataSource) 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 *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 { @@ -9150,14 +10565,34 @@ func (s *DeleteDatasetInput) Validate() error { return nil } -// SetDatasetArn sets the DatasetArn field's value. -func (s *DeleteDatasetInput) SetDatasetArn(v string) *DeleteDatasetInput { - s.DatasetArn = &v +// SetS3Config sets the S3Config field's value. +func (s *DataSource) SetS3Config(v *S3Config) *DataSource { + s.S3Config = v return s } -type DeleteDatasetOutput struct { +// Provides a summary of the dataset group properties used in the ListDatasetGroups +// (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetGroups.html) +// operation. To get the complete set of properties, call the DescribeDatasetGroup +// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetGroup.html) +// 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 + // (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) + // 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. @@ -9165,7 +10600,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 DatasetGroupSummary) String() string { return awsutil.Prettify(s) } @@ -9174,17 +10609,86 @@ 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 DatasetGroupSummary) GoString() string { return s.String() } -type DeleteExplainabilityExportInput struct { +// 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 +// (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasetImportJobs.html) +// operation. To get the complete set of properties, call the DescribeDatasetImportJob +// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDatasetImportJob.html) +// operation, and provide the DatasetImportJobArn. +type DatasetImportJobSummary struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the Explainability export to delete. + // 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. // - // ExplainabilityExportArn is a required field - ExplainabilityExportArn *string `type:"string" required:"true"` + // 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. @@ -9192,7 +10696,7 @@ type DeleteExplainabilityExportInput 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 DeleteExplainabilityExportInput) String() string { +func (s DatasetImportJobSummary) String() string { return awsutil.Prettify(s) } @@ -9201,58 +10705,80 @@ func (s DeleteExplainabilityExportInput) 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 DeleteExplainabilityExportInput) GoString() string { +func (s DatasetImportJobSummary) GoString() string { return s.String() } -// 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")) - } +// SetCreationTime sets the CreationTime field's value. +func (s *DatasetImportJobSummary) SetCreationTime(v time.Time) *DatasetImportJobSummary { + s.CreationTime = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetDataSource sets the DataSource field's value. +func (s *DatasetImportJobSummary) SetDataSource(v *DataSource) *DatasetImportJobSummary { + s.DataSource = v + return s } -// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value. -func (s *DeleteExplainabilityExportInput) SetExplainabilityExportArn(v string) *DeleteExplainabilityExportInput { - s.ExplainabilityExportArn = &v +// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. +func (s *DatasetImportJobSummary) SetDatasetImportJobArn(v string) *DatasetImportJobSummary { + s.DatasetImportJobArn = &v return s } -type DeleteExplainabilityExportOutput struct { - _ struct{} `type:"structure"` +// SetDatasetImportJobName sets the DatasetImportJobName field's value. +func (s *DatasetImportJobSummary) SetDatasetImportJobName(v string) *DatasetImportJobSummary { + s.DatasetImportJobName = &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 DeleteExplainabilityExportOutput) String() string { - return awsutil.Prettify(s) +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DatasetImportJobSummary) SetLastModificationTime(v time.Time) *DatasetImportJobSummary { + 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 DeleteExplainabilityExportOutput) GoString() string { - return s.String() +// SetMessage sets the Message field's value. +func (s *DatasetImportJobSummary) SetMessage(v string) *DatasetImportJobSummary { + s.Message = &v + return s } -type DeleteExplainabilityInput struct { +// 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 (https://docs.aws.amazon.com/forecast/latest/dg/API_ListDatasets.html) +// operation. To get the complete set of properties, call the DescribeDataset +// (https://docs.aws.amazon.com/forecast/latest/dg/API_DescribeDataset.html) +// operation, and provide the DatasetArn. +type DatasetSummary struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the Explainability resource to delete. - // - // ExplainabilityArn is a required field - ExplainabilityArn *string `type:"string" required:"true"` + // 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 (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) + // operation has finished, LastModificationTime is when the import job completed + // or failed. + LastModificationTime *time.Time `type:"timestamp"` } // String returns the string representation. @@ -9260,7 +10786,7 @@ type DeleteExplainabilityInput 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 DeleteExplainabilityInput) String() string { +func (s DatasetSummary) String() string { return awsutil.Prettify(s) } @@ -9269,58 +10795,53 @@ func (s DeleteExplainabilityInput) 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 DeleteExplainabilityInput) GoString() string { +func (s DatasetSummary) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteExplainabilityInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteExplainabilityInput"} - if s.ExplainabilityArn == nil { - invalidParams.Add(request.NewErrParamRequired("ExplainabilityArn")) - } +// SetCreationTime sets the CreationTime field's value. +func (s *DatasetSummary) SetCreationTime(v time.Time) *DatasetSummary { + s.CreationTime = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetDatasetArn sets the DatasetArn field's value. +func (s *DatasetSummary) SetDatasetArn(v string) *DatasetSummary { + s.DatasetArn = &v + return s } -// SetExplainabilityArn sets the ExplainabilityArn field's value. -func (s *DeleteExplainabilityInput) SetExplainabilityArn(v string) *DeleteExplainabilityInput { - s.ExplainabilityArn = &v +// SetDatasetName sets the DatasetName field's value. +func (s *DatasetSummary) SetDatasetName(v string) *DatasetSummary { + s.DatasetName = &v return s } -type DeleteExplainabilityOutput struct { - _ struct{} `type:"structure"` +// SetDatasetType sets the DatasetType field's value. +func (s *DatasetSummary) SetDatasetType(v string) *DatasetSummary { + s.DatasetType = &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 DeleteExplainabilityOutput) String() string { - return awsutil.Prettify(s) +// SetDomain sets the Domain field's value. +func (s *DatasetSummary) SetDomain(v string) *DatasetSummary { + 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 DeleteExplainabilityOutput) GoString() string { - return s.String() +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DatasetSummary) SetLastModificationTime(v time.Time) *DatasetSummary { + s.LastModificationTime = &v + return s } -type DeleteForecastExportJobInput struct { +type DeleteDatasetGroupInput 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 to delete. // - // 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. @@ -9328,7 +10849,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 DeleteDatasetGroupInput) String() string { return awsutil.Prettify(s) } @@ -9337,15 +10858,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 DeleteDatasetGroupInput) 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 *DeleteDatasetGroupInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteDatasetGroupInput"} + if s.DatasetGroupArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn")) } if invalidParams.Len() > 0 { @@ -9354,13 +10875,13 @@ 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 *DeleteDatasetGroupInput) SetDatasetGroupArn(v string) *DeleteDatasetGroupInput { + s.DatasetGroupArn = &v return s } -type DeleteForecastExportJobOutput struct { +type DeleteDatasetGroupOutput struct { _ struct{} `type:"structure"` } @@ -9369,7 +10890,7 @@ type DeleteForecastExportJobOutput 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 DeleteForecastExportJobOutput) String() string { +func (s DeleteDatasetGroupOutput) String() string { return awsutil.Prettify(s) } @@ -9378,17 +10899,17 @@ func (s DeleteForecastExportJobOutput) 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 DeleteForecastExportJobOutput) GoString() string { +func (s DeleteDatasetGroupOutput) GoString() string { return s.String() } -type DeleteForecastInput struct { +type DeleteDatasetImportJobInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the forecast to delete. + // The Amazon Resource Name (ARN) of the dataset import job to delete. // - // ForecastArn is a required field - ForecastArn *string `type:"string" required:"true"` + // DatasetImportJobArn is a required field + DatasetImportJobArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -9396,7 +10917,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 DeleteDatasetImportJobInput) String() string { return awsutil.Prettify(s) } @@ -9405,15 +10926,15 @@ 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 DeleteDatasetImportJobInput) 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")) +func (s *DeleteDatasetImportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteDatasetImportJobInput"} + if s.DatasetImportJobArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetImportJobArn")) } if invalidParams.Len() > 0 { @@ -9422,13 +10943,13 @@ func (s *DeleteForecastInput) Validate() error { return nil } -// SetForecastArn sets the ForecastArn field's value. -func (s *DeleteForecastInput) SetForecastArn(v string) *DeleteForecastInput { - s.ForecastArn = &v +// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. +func (s *DeleteDatasetImportJobInput) SetDatasetImportJobArn(v string) *DeleteDatasetImportJobInput { + s.DatasetImportJobArn = &v return s } -type DeleteForecastOutput struct { +type DeleteDatasetImportJobOutput struct { _ struct{} `type:"structure"` } @@ -9437,7 +10958,7 @@ type DeleteForecastOutput 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 DeleteForecastOutput) String() string { +func (s DeleteDatasetImportJobOutput) String() string { return awsutil.Prettify(s) } @@ -9446,17 +10967,17 @@ func (s DeleteForecastOutput) 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 DeleteForecastOutput) GoString() string { +func (s DeleteDatasetImportJobOutput) GoString() string { return s.String() } -type DeleteMonitorInput struct { +type DeleteDatasetInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the monitor resource to delete. + // The Amazon Resource Name (ARN) of the dataset to delete. // - // MonitorArn is a required field - MonitorArn *string `type:"string" required:"true"` + // DatasetArn is a required field + DatasetArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -9464,7 +10985,7 @@ type DeleteMonitorInput 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 DeleteMonitorInput) String() string { +func (s DeleteDatasetInput) String() string { return awsutil.Prettify(s) } @@ -9473,15 +10994,15 @@ func (s DeleteMonitorInput) 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 DeleteMonitorInput) GoString() string { +func (s DeleteDatasetInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DeleteMonitorInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteMonitorInput"} - if s.MonitorArn == nil { - invalidParams.Add(request.NewErrParamRequired("MonitorArn")) +func (s *DeleteDatasetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteDatasetInput"} + if s.DatasetArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetArn")) } if invalidParams.Len() > 0 { @@ -9490,13 +11011,13 @@ func (s *DeleteMonitorInput) Validate() error { return nil } -// SetMonitorArn sets the MonitorArn field's value. -func (s *DeleteMonitorInput) SetMonitorArn(v string) *DeleteMonitorInput { - s.MonitorArn = &v +// SetDatasetArn sets the DatasetArn field's value. +func (s *DeleteDatasetInput) SetDatasetArn(v string) *DeleteDatasetInput { + s.DatasetArn = &v return s } -type DeleteMonitorOutput struct { +type DeleteDatasetOutput struct { _ struct{} `type:"structure"` } @@ -9505,7 +11026,7 @@ type DeleteMonitorOutput 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 DeleteMonitorOutput) String() string { +func (s DeleteDatasetOutput) String() string { return awsutil.Prettify(s) } @@ -9514,17 +11035,17 @@ func (s DeleteMonitorOutput) 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 DeleteMonitorOutput) GoString() string { +func (s DeleteDatasetOutput) GoString() string { return s.String() } -type DeletePredictorBacktestExportJobInput struct { +type DeleteExplainabilityExportInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the predictor backtest export job to delete. + // The Amazon Resource Name (ARN) of the Explainability export to delete. // - // PredictorBacktestExportJobArn is a required field - PredictorBacktestExportJobArn *string `type:"string" required:"true"` + // ExplainabilityExportArn is a required field + ExplainabilityExportArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -9532,7 +11053,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 DeleteExplainabilityExportInput) String() string { return awsutil.Prettify(s) } @@ -9541,15 +11062,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 DeleteExplainabilityExportInput) 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 *DeleteExplainabilityExportInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteExplainabilityExportInput"} + if s.ExplainabilityExportArn == nil { + invalidParams.Add(request.NewErrParamRequired("ExplainabilityExportArn")) } if invalidParams.Len() > 0 { @@ -9558,13 +11079,13 @@ func (s *DeletePredictorBacktestExportJobInput) Validate() error { return nil } -// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value. -func (s *DeletePredictorBacktestExportJobInput) SetPredictorBacktestExportJobArn(v string) *DeletePredictorBacktestExportJobInput { - s.PredictorBacktestExportJobArn = &v +// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value. +func (s *DeleteExplainabilityExportInput) SetExplainabilityExportArn(v string) *DeleteExplainabilityExportInput { + s.ExplainabilityExportArn = &v return s } -type DeletePredictorBacktestExportJobOutput struct { +type DeleteExplainabilityExportOutput struct { _ struct{} `type:"structure"` } @@ -9573,7 +11094,7 @@ type DeletePredictorBacktestExportJobOutput 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 DeletePredictorBacktestExportJobOutput) String() string { +func (s DeleteExplainabilityExportOutput) String() string { return awsutil.Prettify(s) } @@ -9582,17 +11103,17 @@ func (s DeletePredictorBacktestExportJobOutput) 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 DeletePredictorBacktestExportJobOutput) GoString() string { +func (s DeleteExplainabilityExportOutput) GoString() string { return s.String() } -type DeletePredictorInput struct { +type DeleteExplainabilityInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the predictor to delete. + // The Amazon Resource Name (ARN) of the Explainability resource to delete. // - // PredictorArn is a required field - PredictorArn *string `type:"string" required:"true"` + // ExplainabilityArn is a required field + ExplainabilityArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -9600,7 +11121,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 DeleteExplainabilityInput) String() string { return awsutil.Prettify(s) } @@ -9609,15 +11130,15 @@ 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 DeleteExplainabilityInput) 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")) +func (s *DeleteExplainabilityInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteExplainabilityInput"} + if s.ExplainabilityArn == nil { + invalidParams.Add(request.NewErrParamRequired("ExplainabilityArn")) } if invalidParams.Len() > 0 { @@ -9626,13 +11147,13 @@ func (s *DeletePredictorInput) Validate() error { return nil } -// SetPredictorArn sets the PredictorArn field's value. -func (s *DeletePredictorInput) SetPredictorArn(v string) *DeletePredictorInput { - s.PredictorArn = &v +// SetExplainabilityArn sets the ExplainabilityArn field's value. +func (s *DeleteExplainabilityInput) SetExplainabilityArn(v string) *DeleteExplainabilityInput { + s.ExplainabilityArn = &v return s } -type DeletePredictorOutput struct { +type DeleteExplainabilityOutput struct { _ struct{} `type:"structure"` } @@ -9641,7 +11162,7 @@ type DeletePredictorOutput 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 DeletePredictorOutput) String() string { +func (s DeleteExplainabilityOutput) String() string { return awsutil.Prettify(s) } @@ -9650,18 +11171,17 @@ func (s DeletePredictorOutput) 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 DeletePredictorOutput) GoString() string { +func (s DeleteExplainabilityOutput) GoString() string { return s.String() } -type DeleteResourceTreeInput struct { +type DeleteForecastExportJobInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the parent resource to delete. All child - // resources of the parent resource will also be deleted. + // The Amazon Resource Name (ARN) of the forecast export job to delete. // - // ResourceArn is a required field - ResourceArn *string `type:"string" required:"true"` + // ForecastExportJobArn is a required field + ForecastExportJobArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -9669,7 +11189,7 @@ type DeleteResourceTreeInput 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 DeleteResourceTreeInput) String() string { +func (s DeleteForecastExportJobInput) String() string { return awsutil.Prettify(s) } @@ -9678,15 +11198,15 @@ func (s DeleteResourceTreeInput) 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 DeleteResourceTreeInput) 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 *DeleteResourceTreeInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DeleteResourceTreeInput"} - if s.ResourceArn == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceArn")) +func (s *DeleteForecastExportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteForecastExportJobInput"} + if s.ForecastExportJobArn == nil { + invalidParams.Add(request.NewErrParamRequired("ForecastExportJobArn")) } if invalidParams.Len() > 0 { @@ -9695,13 +11215,13 @@ func (s *DeleteResourceTreeInput) Validate() error { return nil } -// SetResourceArn sets the ResourceArn field's value. -func (s *DeleteResourceTreeInput) SetResourceArn(v string) *DeleteResourceTreeInput { - s.ResourceArn = &v +// SetForecastExportJobArn sets the ForecastExportJobArn field's value. +func (s *DeleteForecastExportJobInput) SetForecastExportJobArn(v string) *DeleteForecastExportJobInput { + s.ForecastExportJobArn = &v return s } -type DeleteResourceTreeOutput struct { +type DeleteForecastExportJobOutput struct { _ struct{} `type:"structure"` } @@ -9710,7 +11230,7 @@ type DeleteResourceTreeOutput 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 DeleteResourceTreeOutput) String() string { +func (s DeleteForecastExportJobOutput) String() string { return awsutil.Prettify(s) } @@ -9719,17 +11239,17 @@ func (s DeleteResourceTreeOutput) 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 DeleteResourceTreeOutput) GoString() string { +func (s DeleteForecastExportJobOutput) GoString() string { return s.String() } -type DescribeAutoPredictorInput struct { +type DeleteForecastInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the predictor. + // The Amazon Resource Name (ARN) of the forecast to delete. // - // PredictorArn is a required field - PredictorArn *string `type:"string" required:"true"` + // ForecastArn is a required field + ForecastArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -9737,7 +11257,7 @@ type DescribeAutoPredictorInput 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 DescribeAutoPredictorInput) String() string { +func (s DeleteForecastInput) String() string { return awsutil.Prettify(s) } @@ -9746,15 +11266,15 @@ func (s DescribeAutoPredictorInput) 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 DescribeAutoPredictorInput) GoString() string { +func (s DeleteForecastInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeAutoPredictorInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeAutoPredictorInput"} - if s.PredictorArn == nil { - invalidParams.Add(request.NewErrParamRequired("PredictorArn")) +func (s *DeleteForecastInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteForecastInput"} + if s.ForecastArn == nil { + invalidParams.Add(request.NewErrParamRequired("ForecastArn")) } if invalidParams.Len() > 0 { @@ -9763,102 +11283,14 @@ func (s *DescribeAutoPredictorInput) Validate() error { return nil } -// SetPredictorArn sets the PredictorArn field's value. -func (s *DescribeAutoPredictorInput) SetPredictorArn(v string) *DescribeAutoPredictorInput { - s.PredictorArn = &v +// SetForecastArn sets the ForecastArn field's value. +func (s *DeleteForecastInput) SetForecastArn(v string) *DeleteForecastInput { + s.ForecastArn = &v return s } -type DescribeAutoPredictorOutput struct { +type DeleteForecastOutput 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"` - - // Provides the status and ARN of the Predictor Explainability. - ExplainabilityInfo *ExplainabilityInfo `type:"structure"` - - // An array of dimension (field) names that specify the attributes used to group - // your time series. - ForecastDimensions []*string `min:"1" type:"list"` - - // 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"` - - // A object with the Amazon Resource Name (ARN) and status of the monitor resource. - MonitorInfo *MonitorInfo `type:"structure"` - - // 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"` - - // The time boundary Forecast uses when aggregating data. - TimeAlignmentBoundary *TimeAlignmentBoundary `type:"structure"` } // String returns the string representation. @@ -9866,7 +11298,7 @@ type DescribeAutoPredictorOutput 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 DescribeAutoPredictorOutput) String() string { +func (s DeleteForecastOutput) String() string { return awsutil.Prettify(s) } @@ -9875,131 +11307,17 @@ func (s DescribeAutoPredictorOutput) 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 DescribeAutoPredictorOutput) GoString() string { +func (s DeleteForecastOutput) GoString() string { return s.String() } -// 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 -} - -// SetForecastDimensions sets the ForecastDimensions field's value. -func (s *DescribeAutoPredictorOutput) SetForecastDimensions(v []*string) *DescribeAutoPredictorOutput { - s.ForecastDimensions = 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 -} - -// SetMonitorInfo sets the MonitorInfo field's value. -func (s *DescribeAutoPredictorOutput) SetMonitorInfo(v *MonitorInfo) *DescribeAutoPredictorOutput { - s.MonitorInfo = 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 -} - -// SetTimeAlignmentBoundary sets the TimeAlignmentBoundary field's value. -func (s *DescribeAutoPredictorOutput) SetTimeAlignmentBoundary(v *TimeAlignmentBoundary) *DescribeAutoPredictorOutput { - s.TimeAlignmentBoundary = v - return s -} - -type DescribeDatasetGroupInput struct { +type DeleteMonitorInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset group. + // The Amazon Resource Name (ARN) of the monitor resource to delete. // - // DatasetGroupArn is a required field - DatasetGroupArn *string `type:"string" required:"true"` + // MonitorArn is a required field + MonitorArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -10007,7 +11325,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 DeleteMonitorInput) String() string { return awsutil.Prettify(s) } @@ -10016,15 +11334,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 DeleteMonitorInput) 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 *DeleteMonitorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteMonitorInput"} + if s.MonitorArn == nil { + invalidParams.Add(request.NewErrParamRequired("MonitorArn")) } if invalidParams.Len() > 0 { @@ -10033,53 +11351,41 @@ func (s *DescribeDatasetGroupInput) Validate() error { return nil } -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *DescribeDatasetGroupInput) SetDatasetGroupArn(v string) *DescribeDatasetGroupInput { - s.DatasetGroupArn = &v +// SetMonitorArn sets the MonitorArn field's value. +func (s *DeleteMonitorInput) SetMonitorArn(v string) *DeleteMonitorInput { + s.MonitorArn = &v return s } -type DescribeDatasetGroupOutput struct { +type DeleteMonitorOutput struct { _ struct{} `type:"structure"` +} - // When the dataset group 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 ARN of the dataset group. - DatasetGroupArn *string `type:"string"` - - // The name of the dataset group. - DatasetGroupName *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 DeleteMonitorOutput) String() string { + return awsutil.Prettify(s) +} - // The domain associated with the dataset group. - Domain *string `type:"string" enum:"Domain"` +// 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 DeleteMonitorOutput) GoString() string { + return s.String() +} - // When the dataset group was created or last updated from a call to the UpdateDatasetGroup - // (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) - // operation. While the dataset group is being updated, LastModificationTime - // is the current time of the DescribeDatasetGroup call. - LastModificationTime *time.Time `type:"timestamp"` +type DeletePredictorBacktestExportJobInput struct { + _ struct{} `type:"structure"` - // The status of the dataset group. 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 when you call the UpdateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) - // operation. + // The Amazon Resource Name (ARN) of the predictor backtest export job to delete. // - // The Status of the dataset group must be ACTIVE before you can use the dataset - // group to create a predictor. - Status *string `type:"string"` + // PredictorBacktestExportJobArn is a required field + PredictorBacktestExportJobArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -10087,7 +11393,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 DeletePredictorBacktestExportJobInput) String() string { return awsutil.Prettify(s) } @@ -10096,59 +11402,58 @@ 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 DeletePredictorBacktestExportJobInput) GoString() string { return s.String() } -// SetCreationTime sets the CreationTime field's value. -func (s *DescribeDatasetGroupOutput) SetCreationTime(v time.Time) *DescribeDatasetGroupOutput { - s.CreationTime = &v - return s -} - -// SetDatasetArns sets the DatasetArns field's value. -func (s *DescribeDatasetGroupOutput) SetDatasetArns(v []*string) *DescribeDatasetGroupOutput { - s.DatasetArns = 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")) + } -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *DescribeDatasetGroupOutput) SetDatasetGroupArn(v string) *DescribeDatasetGroupOutput { - s.DatasetGroupArn = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetDatasetGroupName sets the DatasetGroupName field's value. -func (s *DescribeDatasetGroupOutput) SetDatasetGroupName(v string) *DescribeDatasetGroupOutput { - s.DatasetGroupName = &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 *DescribeDatasetGroupOutput) SetDomain(v string) *DescribeDatasetGroupOutput { - s.Domain = &v - return s +type DeletePredictorBacktestExportJobOutput struct { + _ struct{} `type:"structure"` } -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *DescribeDatasetGroupOutput) SetLastModificationTime(v time.Time) *DescribeDatasetGroupOutput { - 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) } -// SetStatus sets the Status field's value. -func (s *DescribeDatasetGroupOutput) SetStatus(v string) *DescribeDatasetGroupOutput { - 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 DeletePredictorBacktestExportJobOutput) GoString() string { + return s.String() } -type DescribeDatasetImportJobInput struct { +type DeletePredictorInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset import job. + // The Amazon Resource Name (ARN) of the predictor to delete. // - // DatasetImportJobArn is a required field - DatasetImportJobArn *string `type:"string" required:"true"` + // PredictorArn is a required field + PredictorArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -10156,7 +11461,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 DeletePredictorInput) String() string { return awsutil.Prettify(s) } @@ -10165,15 +11470,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 DeletePredictorInput) 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 *DeletePredictorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeletePredictorInput"} + if s.PredictorArn == nil { + invalidParams.Add(request.NewErrParamRequired("PredictorArn")) } if invalidParams.Len() > 0 { @@ -10182,93 +11487,42 @@ func (s *DescribeDatasetImportJobInput) Validate() error { return nil } -// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. -func (s *DescribeDatasetImportJobInput) SetDatasetImportJobArn(v string) *DescribeDatasetImportJobInput { - s.DatasetImportJobArn = &v +// SetPredictorArn sets the PredictorArn field's value. +func (s *DeletePredictorInput) SetPredictorArn(v string) *DeletePredictorInput { + s.PredictorArn = &v return s } -type DescribeDatasetImportJobOutput struct { +type DeletePredictorOutput struct { _ struct{} `type:"structure"` +} - // When the dataset import job 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 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 imported data, CSV or PARQUET. - Format *string `type:"string"` - - // 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"` +// 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) +} - // 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"` +// 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() +} - // The single time zone applied to every item in the dataset - TimeZone *string `type:"string"` +type DeleteResourceTreeInput struct { + _ struct{} `type:"structure"` - // 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 + // The Amazon Resource Name (ARN) of the parent resource to delete. All child + // resources of the parent resource will also be deleted. // - // * "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"` + // ResourceArn is a required field + ResourceArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -10276,7 +11530,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 DeleteResourceTreeInput) String() string { return awsutil.Prettify(s) } @@ -10285,113 +11539,58 @@ 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 DeleteResourceTreeInput) GoString() string { return s.String() } -// SetCreationTime sets the CreationTime field's value. -func (s *DescribeDatasetImportJobOutput) SetCreationTime(v time.Time) *DescribeDatasetImportJobOutput { - s.CreationTime = &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")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// 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 - return s -} - -// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value. -func (s *DescribeDatasetImportJobOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeDatasetImportJobOutput { - s.EstimatedTimeRemainingInMinutes = &v - return s -} - -// SetFieldStatistics sets the FieldStatistics field's value. -func (s *DescribeDatasetImportJobOutput) SetFieldStatistics(v map[string]*Statistics) *DescribeDatasetImportJobOutput { - s.FieldStatistics = v - return s -} - -// SetFormat sets the Format field's value. -func (s *DescribeDatasetImportJobOutput) SetFormat(v string) *DescribeDatasetImportJobOutput { - s.Format = &v - return s -} - -// SetGeolocationFormat sets the GeolocationFormat field's value. -func (s *DescribeDatasetImportJobOutput) SetGeolocationFormat(v string) *DescribeDatasetImportJobOutput { - s.GeolocationFormat = &v - return s -} - -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *DescribeDatasetImportJobOutput) SetLastModificationTime(v time.Time) *DescribeDatasetImportJobOutput { - s.LastModificationTime = &v - return s -} - -// SetMessage sets the Message field's value. -func (s *DescribeDatasetImportJobOutput) SetMessage(v string) *DescribeDatasetImportJobOutput { - s.Message = &v - return s -} - -// SetStatus sets the Status field's value. -func (s *DescribeDatasetImportJobOutput) SetStatus(v string) *DescribeDatasetImportJobOutput { - s.Status = &v +// SetResourceArn sets the ResourceArn field's value. +func (s *DeleteResourceTreeInput) SetResourceArn(v string) *DeleteResourceTreeInput { + s.ResourceArn = &v return s } -// SetTimeZone sets the TimeZone field's value. -func (s *DescribeDatasetImportJobOutput) SetTimeZone(v string) *DescribeDatasetImportJobOutput { - s.TimeZone = &v - return s +type DeleteResourceTreeOutput struct { + _ struct{} `type:"structure"` } -// SetTimestampFormat sets the TimestampFormat field's value. -func (s *DescribeDatasetImportJobOutput) SetTimestampFormat(v string) *DescribeDatasetImportJobOutput { - s.TimestampFormat = &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) } -// SetUseGeolocationForTimeZone sets the UseGeolocationForTimeZone field's value. -func (s *DescribeDatasetImportJobOutput) SetUseGeolocationForTimeZone(v bool) *DescribeDatasetImportJobOutput { - s.UseGeolocationForTimeZone = &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() } -type DescribeDatasetInput struct { +type DeleteWhatIfAnalysisInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset. + // The Amazon Resource Name (ARN) of the what-if analysis that you want to delete. // - // DatasetArn is a required field - DatasetArn *string `type:"string" required:"true"` + // WhatIfAnalysisArn is a required field + WhatIfAnalysisArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -10399,7 +11598,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 DeleteWhatIfAnalysisInput) String() string { return awsutil.Prettify(s) } @@ -10408,15 +11607,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 DeleteWhatIfAnalysisInput) 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 *DeleteWhatIfAnalysisInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteWhatIfAnalysisInput"} + if s.WhatIfAnalysisArn == nil { + invalidParams.Add(request.NewErrParamRequired("WhatIfAnalysisArn")) } if invalidParams.Len() > 0 { @@ -10425,72 +11624,14 @@ func (s *DescribeDatasetInput) Validate() error { return nil } -// SetDatasetArn sets the DatasetArn field's value. -func (s *DescribeDatasetInput) SetDatasetArn(v string) *DescribeDatasetInput { - s.DatasetArn = &v +// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value. +func (s *DeleteWhatIfAnalysisInput) SetWhatIfAnalysisArn(v string) *DeleteWhatIfAnalysisInput { + s.WhatIfAnalysisArn = &v return s } -type DescribeDatasetOutput struct { +type DeleteWhatIfAnalysisOutput struct { _ struct{} `type:"structure"` - - // When the dataset 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 `min:"1" type:"string"` - - // 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"` - - // 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 - // (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) - // operation has finished, LastModificationTime is when the import job completed - // 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. - Schema *Schema `type:"structure"` - - // The status of the dataset. 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 (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) - // 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. - Status *string `type:"string"` } // String returns the string representation. @@ -10498,7 +11639,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 DeleteWhatIfAnalysisOutput) String() string { return awsutil.Prettify(s) } @@ -10507,77 +11648,86 @@ 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 DeleteWhatIfAnalysisOutput) GoString() string { return s.String() } -// SetCreationTime sets the CreationTime field's value. -func (s *DescribeDatasetOutput) SetCreationTime(v time.Time) *DescribeDatasetOutput { - s.CreationTime = &v - return s -} +type DeleteWhatIfForecastExportInput struct { + _ struct{} `type:"structure"` -// SetDataFrequency sets the DataFrequency field's value. -func (s *DescribeDatasetOutput) SetDataFrequency(v string) *DescribeDatasetOutput { - s.DataFrequency = &v - return s + // The Amazon Resource Name (ARN) of the what-if forecast export that you want + // to delete. + // + // WhatIfForecastExportArn is a required field + WhatIfForecastExportArn *string `type:"string" required:"true"` } -// SetDatasetArn sets the DatasetArn field's value. -func (s *DescribeDatasetOutput) SetDatasetArn(v string) *DescribeDatasetOutput { - s.DatasetArn = &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 DeleteWhatIfForecastExportInput) String() string { + return awsutil.Prettify(s) } -// SetDatasetName sets the DatasetName field's value. -func (s *DescribeDatasetOutput) SetDatasetName(v string) *DescribeDatasetOutput { - s.DatasetName = &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 DeleteWhatIfForecastExportInput) GoString() string { + return s.String() } -// SetDatasetType sets the DatasetType field's value. -func (s *DescribeDatasetOutput) SetDatasetType(v string) *DescribeDatasetOutput { - s.DatasetType = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteWhatIfForecastExportInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteWhatIfForecastExportInput"} + if s.WhatIfForecastExportArn == nil { + invalidParams.Add(request.NewErrParamRequired("WhatIfForecastExportArn")) + } -// SetDomain sets the Domain field's value. -func (s *DescribeDatasetOutput) SetDomain(v string) *DescribeDatasetOutput { - s.Domain = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetEncryptionConfig sets the EncryptionConfig field's value. -func (s *DescribeDatasetOutput) SetEncryptionConfig(v *EncryptionConfig) *DescribeDatasetOutput { - s.EncryptionConfig = v +// SetWhatIfForecastExportArn sets the WhatIfForecastExportArn field's value. +func (s *DeleteWhatIfForecastExportInput) SetWhatIfForecastExportArn(v string) *DeleteWhatIfForecastExportInput { + s.WhatIfForecastExportArn = &v return s } -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *DescribeDatasetOutput) SetLastModificationTime(v time.Time) *DescribeDatasetOutput { - s.LastModificationTime = &v - return s +type DeleteWhatIfForecastExportOutput struct { + _ struct{} `type:"structure"` } -// SetSchema sets the Schema field's value. -func (s *DescribeDatasetOutput) SetSchema(v *Schema) *DescribeDatasetOutput { - s.Schema = 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 DeleteWhatIfForecastExportOutput) String() string { + return awsutil.Prettify(s) } -// SetStatus sets the Status field's value. -func (s *DescribeDatasetOutput) SetStatus(v string) *DescribeDatasetOutput { - 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 DeleteWhatIfForecastExportOutput) GoString() string { + return s.String() } -type DescribeExplainabilityExportInput struct { +type DeleteWhatIfForecastInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the Explainability export. + // The Amazon Resource Name (ARN) of the what-if forecast that you want to delete. // - // ExplainabilityExportArn is a required field - ExplainabilityExportArn *string `type:"string" required:"true"` + // WhatIfForecastArn is a required field + WhatIfForecastArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -10585,7 +11735,7 @@ type DescribeExplainabilityExportInput 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 DescribeExplainabilityExportInput) String() string { +func (s DeleteWhatIfForecastInput) String() string { return awsutil.Prettify(s) } @@ -10594,15 +11744,15 @@ func (s DescribeExplainabilityExportInput) 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 DescribeExplainabilityExportInput) GoString() string { +func (s DeleteWhatIfForecastInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DescribeExplainabilityExportInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeExplainabilityExportInput"} - if s.ExplainabilityExportArn == nil { - invalidParams.Add(request.NewErrParamRequired("ExplainabilityExportArn")) +func (s *DeleteWhatIfForecastInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteWhatIfForecastInput"} + if s.WhatIfForecastArn == nil { + invalidParams.Add(request.NewErrParamRequired("WhatIfForecastArn")) } if invalidParams.Len() > 0 { @@ -10611,62 +11761,14 @@ func (s *DescribeExplainabilityExportInput) Validate() error { return nil } -// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value. -func (s *DescribeExplainabilityExportInput) SetExplainabilityExportArn(v string) *DescribeExplainabilityExportInput { - s.ExplainabilityExportArn = &v +// SetWhatIfForecastArn sets the WhatIfForecastArn field's value. +func (s *DeleteWhatIfForecastInput) SetWhatIfForecastArn(v string) *DeleteWhatIfForecastInput { + s.WhatIfForecastArn = &v return s } -type DescribeExplainabilityExportOutput struct { +type DeleteWhatIfForecastOutput struct { _ struct{} `type:"structure"` - - // When the Explainability export 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. - ExplainabilityArn *string `type:"string"` - - // 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 format of the exported data, CSV or PARQUET. - Format *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"` - - // Information about any errors that occurred during the export. - Message *string `type:"string"` - - // The status of the Explainability export. 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. @@ -10674,7 +11776,7 @@ type DescribeExplainabilityExportOutput 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 DescribeExplainabilityExportOutput) String() string { +func (s DeleteWhatIfForecastOutput) String() string { return awsutil.Prettify(s) } @@ -10683,71 +11785,17 @@ func (s DescribeExplainabilityExportOutput) 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 DescribeExplainabilityExportOutput) GoString() string { +func (s DeleteWhatIfForecastOutput) GoString() string { return s.String() } -// SetCreationTime sets the CreationTime field's value. -func (s *DescribeExplainabilityExportOutput) SetCreationTime(v time.Time) *DescribeExplainabilityExportOutput { - s.CreationTime = &v - return s -} - -// SetDestination sets the Destination field's value. -func (s *DescribeExplainabilityExportOutput) SetDestination(v *DataDestination) *DescribeExplainabilityExportOutput { - s.Destination = v - return s -} - -// SetExplainabilityArn sets the ExplainabilityArn field's value. -func (s *DescribeExplainabilityExportOutput) SetExplainabilityArn(v string) *DescribeExplainabilityExportOutput { - s.ExplainabilityArn = &v - return s -} - -// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value. -func (s *DescribeExplainabilityExportOutput) SetExplainabilityExportArn(v string) *DescribeExplainabilityExportOutput { - s.ExplainabilityExportArn = &v - return s -} - -// SetExplainabilityExportName sets the ExplainabilityExportName field's value. -func (s *DescribeExplainabilityExportOutput) SetExplainabilityExportName(v string) *DescribeExplainabilityExportOutput { - s.ExplainabilityExportName = &v - return s -} - -// SetFormat sets the Format field's value. -func (s *DescribeExplainabilityExportOutput) SetFormat(v string) *DescribeExplainabilityExportOutput { - s.Format = &v - return s -} - -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *DescribeExplainabilityExportOutput) SetLastModificationTime(v time.Time) *DescribeExplainabilityExportOutput { - s.LastModificationTime = &v - return s -} - -// SetMessage sets the Message field's value. -func (s *DescribeExplainabilityExportOutput) SetMessage(v string) *DescribeExplainabilityExportOutput { - s.Message = &v - return s -} - -// SetStatus sets the Status field's value. -func (s *DescribeExplainabilityExportOutput) SetStatus(v string) *DescribeExplainabilityExportOutput { - s.Status = &v - return s -} - -type DescribeExplainabilityInput struct { +type DescribeAutoPredictorInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the Explaianability to describe. + // The Amazon Resource Name (ARN) of the predictor. // - // ExplainabilityArn is a required field - ExplainabilityArn *string `type:"string" required:"true"` + // PredictorArn is a required field + PredictorArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -10755,7 +11803,7 @@ type DescribeExplainabilityInput 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 DescribeExplainabilityInput) String() string { +func (s DescribeAutoPredictorInput) String() string { return awsutil.Prettify(s) } @@ -10764,15 +11812,15 @@ func (s DescribeExplainabilityInput) 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 DescribeExplainabilityInput) 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 *DescribeExplainabilityInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeExplainabilityInput"} - if s.ExplainabilityArn == nil { - invalidParams.Add(request.NewErrParamRequired("ExplainabilityArn")) +func (s *DescribeAutoPredictorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeAutoPredictorInput"} + if s.PredictorArn == nil { + invalidParams.Add(request.NewErrParamRequired("PredictorArn")) } if invalidParams.Len() > 0 { @@ -10781,42 +11829,55 @@ func (s *DescribeExplainabilityInput) Validate() error { return nil } -// SetExplainabilityArn sets the ExplainabilityArn field's value. -func (s *DescribeExplainabilityInput) SetExplainabilityArn(v string) *DescribeExplainabilityInput { - s.ExplainabilityArn = &v +// SetPredictorArn sets the PredictorArn field's value. +func (s *DescribeAutoPredictorInput) SetPredictorArn(v string) *DescribeAutoPredictorInput { + s.PredictorArn = &v return s } -type DescribeExplainabilityOutput struct { +type DescribeAutoPredictorOutput struct { _ struct{} `type:"structure"` - // When the Explainability resource was created. + // The timestamp of the CreateAutoPredictor request. CreationTime *time.Time `type:"timestamp"` - // The source of your 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. - DataSource *DataSource `type:"structure"` + // The data configuration for your dataset group and any additional datasets. + DataConfig *DataConfig `type:"structure"` - // Whether the visualization was enabled for the Explainability resource. - EnableVisualization *bool `type:"boolean"` + // An array of the ARNs of the dataset import jobs used to import training data + // for the predictor. + DatasetImportJobArns []*string `type:"list"` - // If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability. - EndDateTime *string `type:"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"` - // The estimated time remaining in minutes for the CreateExplainability job - // to complete. + // The estimated time remaining in minutes for the predictor training job to + // complete. EstimatedTimeRemainingInMinutes *int64 `type:"long"` - // The Amazon Resource Name (ARN) of the Explainability. - ExplainabilityArn *string `type:"string"` + // Provides the status and ARN of the Predictor Explainability. + ExplainabilityInfo *ExplainabilityInfo `type:"structure"` - // The configuration settings that define the granularity of time series and - // time points for the Explainability. - ExplainabilityConfig *ExplainabilityConfig `type:"structure"` + // An array of dimension (field) names that specify the attributes used to group + // your time series. + ForecastDimensions []*string `min:"1" type:"list"` - // The name of the Explainability. - ExplainabilityName *string `min:"1" type:"string"` + // The frequency of predictions in a forecast. + // + // Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min + // (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and + // 1min (1 minute). For example, "Y" 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: @@ -10832,20 +11893,26 @@ type DescribeExplainabilityOutput struct { // * ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time `type:"timestamp"` - // If an error occurred, a message about the error. + // In the event of an error, a message detailing the cause of 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"` + // A object with the Amazon Resource Name (ARN) and status of the monitor resource. + MonitorInfo *MonitorInfo `type:"structure"` - // Defines the fields of a dataset. - Schema *Schema `type:"structure"` + // The accuracy metric used to optimize the predictor. + OptimizationMetric *string `type:"string" enum:"OptimizationMetric"` - // If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability. - StartDateTime *string `type:"string"` + // The Amazon Resource Name (ARN) of the predictor + PredictorArn *string `type:"string"` - // The status of the Explainability resource. States include: + // 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 // @@ -10855,6 +11922,9 @@ type DescribeExplainabilityOutput struct { // // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED Status *string `type:"string"` + + // The time boundary Forecast uses when aggregating data. + TimeAlignmentBoundary *TimeAlignmentBoundary `type:"structure"` } // String returns the string representation. @@ -10862,7 +11932,7 @@ type DescribeExplainabilityOutput 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 DescribeExplainabilityOutput) String() string { +func (s DescribeAutoPredictorOutput) String() string { return awsutil.Prettify(s) } @@ -10871,101 +11941,131 @@ func (s DescribeExplainabilityOutput) 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 DescribeExplainabilityOutput) GoString() string { +func (s DescribeAutoPredictorOutput) GoString() string { return s.String() } // SetCreationTime sets the CreationTime field's value. -func (s *DescribeExplainabilityOutput) SetCreationTime(v time.Time) *DescribeExplainabilityOutput { +func (s *DescribeAutoPredictorOutput) SetCreationTime(v time.Time) *DescribeAutoPredictorOutput { s.CreationTime = &v return s } -// SetDataSource sets the DataSource field's value. -func (s *DescribeExplainabilityOutput) SetDataSource(v *DataSource) *DescribeExplainabilityOutput { - s.DataSource = v +// SetDataConfig sets the DataConfig field's value. +func (s *DescribeAutoPredictorOutput) SetDataConfig(v *DataConfig) *DescribeAutoPredictorOutput { + s.DataConfig = v return s } -// SetEnableVisualization sets the EnableVisualization field's value. -func (s *DescribeExplainabilityOutput) SetEnableVisualization(v bool) *DescribeExplainabilityOutput { - s.EnableVisualization = &v +// SetDatasetImportJobArns sets the DatasetImportJobArns field's value. +func (s *DescribeAutoPredictorOutput) SetDatasetImportJobArns(v []*string) *DescribeAutoPredictorOutput { + s.DatasetImportJobArns = v return s } -// SetEndDateTime sets the EndDateTime field's value. -func (s *DescribeExplainabilityOutput) SetEndDateTime(v string) *DescribeExplainabilityOutput { - s.EndDateTime = &v +// 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 *DescribeExplainabilityOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeExplainabilityOutput { +func (s *DescribeAutoPredictorOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeAutoPredictorOutput { s.EstimatedTimeRemainingInMinutes = &v return s } -// SetExplainabilityArn sets the ExplainabilityArn field's value. -func (s *DescribeExplainabilityOutput) SetExplainabilityArn(v string) *DescribeExplainabilityOutput { - s.ExplainabilityArn = &v +// SetExplainabilityInfo sets the ExplainabilityInfo field's value. +func (s *DescribeAutoPredictorOutput) SetExplainabilityInfo(v *ExplainabilityInfo) *DescribeAutoPredictorOutput { + s.ExplainabilityInfo = v return s } -// SetExplainabilityConfig sets the ExplainabilityConfig field's value. -func (s *DescribeExplainabilityOutput) SetExplainabilityConfig(v *ExplainabilityConfig) *DescribeExplainabilityOutput { - s.ExplainabilityConfig = v +// SetForecastDimensions sets the ForecastDimensions field's value. +func (s *DescribeAutoPredictorOutput) SetForecastDimensions(v []*string) *DescribeAutoPredictorOutput { + s.ForecastDimensions = v return s } -// SetExplainabilityName sets the ExplainabilityName field's value. -func (s *DescribeExplainabilityOutput) SetExplainabilityName(v string) *DescribeExplainabilityOutput { - s.ExplainabilityName = &v +// 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 *DescribeExplainabilityOutput) SetLastModificationTime(v time.Time) *DescribeExplainabilityOutput { +func (s *DescribeAutoPredictorOutput) SetLastModificationTime(v time.Time) *DescribeAutoPredictorOutput { s.LastModificationTime = &v return s } // SetMessage sets the Message field's value. -func (s *DescribeExplainabilityOutput) SetMessage(v string) *DescribeExplainabilityOutput { +func (s *DescribeAutoPredictorOutput) SetMessage(v string) *DescribeAutoPredictorOutput { s.Message = &v return s } -// SetResourceArn sets the ResourceArn field's value. -func (s *DescribeExplainabilityOutput) SetResourceArn(v string) *DescribeExplainabilityOutput { - s.ResourceArn = &v +// SetMonitorInfo sets the MonitorInfo field's value. +func (s *DescribeAutoPredictorOutput) SetMonitorInfo(v *MonitorInfo) *DescribeAutoPredictorOutput { + s.MonitorInfo = v return s } -// SetSchema sets the Schema field's value. -func (s *DescribeExplainabilityOutput) SetSchema(v *Schema) *DescribeExplainabilityOutput { - s.Schema = v +// SetOptimizationMetric sets the OptimizationMetric field's value. +func (s *DescribeAutoPredictorOutput) SetOptimizationMetric(v string) *DescribeAutoPredictorOutput { + s.OptimizationMetric = &v return s } -// SetStartDateTime sets the StartDateTime field's value. -func (s *DescribeExplainabilityOutput) SetStartDateTime(v string) *DescribeExplainabilityOutput { - s.StartDateTime = &v +// 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 *DescribeExplainabilityOutput) SetStatus(v string) *DescribeExplainabilityOutput { +func (s *DescribeAutoPredictorOutput) SetStatus(v string) *DescribeAutoPredictorOutput { s.Status = &v return s } -type DescribeForecastExportJobInput struct { +// SetTimeAlignmentBoundary sets the TimeAlignmentBoundary field's value. +func (s *DescribeAutoPredictorOutput) SetTimeAlignmentBoundary(v *TimeAlignmentBoundary) *DescribeAutoPredictorOutput { + s.TimeAlignmentBoundary = v + return s +} + +type DescribeDatasetGroupInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the forecast export job. + // 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. @@ -10973,7 +12073,7 @@ type DescribeForecastExportJobInput 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 DescribeForecastExportJobInput) String() string { +func (s DescribeDatasetGroupInput) String() string { return awsutil.Prettify(s) } @@ -10982,15 +12082,15 @@ func (s DescribeForecastExportJobInput) 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 DescribeForecastExportJobInput) 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 *DescribeForecastExportJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeForecastExportJobInput"} - 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 { @@ -10999,63 +12099,52 @@ func (s *DescribeForecastExportJobInput) Validate() error { return nil } -// SetForecastExportJobArn sets the ForecastExportJobArn field's value. -func (s *DescribeForecastExportJobInput) SetForecastExportJobArn(v string) *DescribeForecastExportJobInput { - s.ForecastExportJobArn = &v +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *DescribeDatasetGroupInput) SetDatasetGroupArn(v string) *DescribeDatasetGroupInput { + s.DatasetGroupArn = &v return s } -type DescribeForecastExportJobOutput struct { +type DescribeDatasetGroupOutput struct { _ struct{} `type:"structure"` - // When the forecast export job was created. + // When the dataset group was created. CreationTime *time.Time `type:"timestamp"` - // The path to the Amazon Simple Storage Service (Amazon S3) bucket where the - // forecast is exported. - Destination *DataDestination `type:"structure"` - - // The Amazon Resource Name (ARN) of the exported forecast. - ForecastArn *string `type:"string"` + // An array of Amazon Resource Names (ARNs) of the datasets contained in the + // dataset group. + DatasetArns []*string `type:"list"` - // The ARN of the forecast export job. - ForecastExportJobArn *string `type:"string"` + // The ARN of the dataset group. + DatasetGroupArn *string `type:"string"` - // The name of the forecast export job. - ForecastExportJobName *string `min:"1" type:"string"` + // The name of the dataset group. + DatasetGroupName *string `min:"1" type:"string"` - // The format of the exported data, CSV or PARQUET. - Format *string `type:"string"` + // The domain associated with the dataset group. + Domain *string `type:"string" enum:"Domain"` - // 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. + // When the dataset group was created or last updated from a call to the UpdateDatasetGroup + // (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) + // operation. While the dataset group is being updated, LastModificationTime + // is the current time of the DescribeDatasetGroup call. LastModificationTime *time.Time `type:"timestamp"` - // If an error occurred, an informational message about the error. - Message *string `type:"string"` - - // The status of the forecast export job. States include: + // The status of the dataset group. States include: // // * ACTIVE // // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED // - // * CREATE_STOPPING, CREATE_STOPPED - // // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED // - // The Status of the forecast export job must be ACTIVE before you can access - // the forecast in your S3 bucket. + // * UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED + // + // The UPDATE states apply when you call the UpdateDatasetGroup (https://docs.aws.amazon.com/forecast/latest/dg/API_UpdateDatasetGroup.html) + // 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"` } @@ -11064,7 +12153,7 @@ type DescribeForecastExportJobOutput 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 DescribeForecastExportJobOutput) String() string { +func (s DescribeDatasetGroupOutput) String() string { return awsutil.Prettify(s) } @@ -11073,71 +12162,59 @@ func (s DescribeForecastExportJobOutput) 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 DescribeForecastExportJobOutput) GoString() string { +func (s DescribeDatasetGroupOutput) GoString() string { return s.String() } // SetCreationTime sets the CreationTime field's value. -func (s *DescribeForecastExportJobOutput) SetCreationTime(v time.Time) *DescribeForecastExportJobOutput { +func (s *DescribeDatasetGroupOutput) SetCreationTime(v time.Time) *DescribeDatasetGroupOutput { s.CreationTime = &v return s } -// SetDestination sets the Destination field's value. -func (s *DescribeForecastExportJobOutput) SetDestination(v *DataDestination) *DescribeForecastExportJobOutput { - s.Destination = v - return s -} - -// SetForecastArn sets the ForecastArn field's value. -func (s *DescribeForecastExportJobOutput) SetForecastArn(v string) *DescribeForecastExportJobOutput { - s.ForecastArn = &v +// SetDatasetArns sets the DatasetArns field's value. +func (s *DescribeDatasetGroupOutput) SetDatasetArns(v []*string) *DescribeDatasetGroupOutput { + s.DatasetArns = v return s } -// SetForecastExportJobArn sets the ForecastExportJobArn field's value. -func (s *DescribeForecastExportJobOutput) SetForecastExportJobArn(v string) *DescribeForecastExportJobOutput { - s.ForecastExportJobArn = &v +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *DescribeDatasetGroupOutput) SetDatasetGroupArn(v string) *DescribeDatasetGroupOutput { + s.DatasetGroupArn = &v return s } -// SetForecastExportJobName sets the ForecastExportJobName field's value. -func (s *DescribeForecastExportJobOutput) SetForecastExportJobName(v string) *DescribeForecastExportJobOutput { - s.ForecastExportJobName = &v +// SetDatasetGroupName sets the DatasetGroupName field's value. +func (s *DescribeDatasetGroupOutput) SetDatasetGroupName(v string) *DescribeDatasetGroupOutput { + s.DatasetGroupName = &v return s } -// SetFormat sets the Format field's value. -func (s *DescribeForecastExportJobOutput) SetFormat(v string) *DescribeForecastExportJobOutput { - s.Format = &v +// SetDomain sets the Domain field's value. +func (s *DescribeDatasetGroupOutput) SetDomain(v string) *DescribeDatasetGroupOutput { + s.Domain = &v return s } // SetLastModificationTime sets the LastModificationTime field's value. -func (s *DescribeForecastExportJobOutput) SetLastModificationTime(v time.Time) *DescribeForecastExportJobOutput { +func (s *DescribeDatasetGroupOutput) SetLastModificationTime(v time.Time) *DescribeDatasetGroupOutput { s.LastModificationTime = &v return s } -// SetMessage sets the Message field's value. -func (s *DescribeForecastExportJobOutput) SetMessage(v string) *DescribeForecastExportJobOutput { - s.Message = &v - return s -} - // SetStatus sets the Status field's value. -func (s *DescribeForecastExportJobOutput) SetStatus(v string) *DescribeForecastExportJobOutput { +func (s *DescribeDatasetGroupOutput) SetStatus(v string) *DescribeDatasetGroupOutput { s.Status = &v return s } -type DescribeForecastInput struct { +type DescribeDatasetImportJobInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the forecast. + // The Amazon Resource Name (ARN) of the dataset import job. // - // ForecastArn is a required field - ForecastArn *string `type:"string" required:"true"` + // DatasetImportJobArn is a required field + DatasetImportJobArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -11145,7 +12222,7 @@ type DescribeForecastInput 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 DescribeForecastInput) String() string { +func (s DescribeDatasetImportJobInput) String() string { return awsutil.Prettify(s) } @@ -11154,15 +12231,15 @@ func (s DescribeForecastInput) 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 DescribeForecastInput) 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 *DescribeForecastInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeForecastInput"} - if s.ForecastArn == nil { - invalidParams.Add(request.NewErrParamRequired("ForecastArn")) +func (s *DescribeDatasetImportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDatasetImportJobInput"} + if s.DatasetImportJobArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetImportJobArn")) } if invalidParams.Len() > 0 { @@ -11171,32 +12248,49 @@ func (s *DescribeForecastInput) Validate() error { return nil } -// SetForecastArn sets the ForecastArn field's value. -func (s *DescribeForecastInput) SetForecastArn(v string) *DescribeForecastInput { - s.ForecastArn = &v +// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. +func (s *DescribeDatasetImportJobInput) SetDatasetImportJobArn(v string) *DescribeDatasetImportJobInput { + s.DatasetImportJobArn = &v return s } -type DescribeForecastOutput struct { +type DescribeDatasetImportJobOutput struct { _ struct{} `type:"structure"` - // When the forecast creation task was created. + // When the dataset import job was created. CreationTime *time.Time `type:"timestamp"` - // The ARN of the dataset group that provided the data used to train the predictor. - DatasetGroupArn *string `type:"string"` + // The size of the dataset in gigabytes (GB) after the import job has finished. + DataSize *float64 `type:"double"` - // The estimated time remaining in minutes for the forecast job to complete. + // 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"` - // The forecast ARN as specified in the request. - ForecastArn *string `type:"string"` + // Statistical information about each field in the input data. + FieldStatistics map[string]*Statistics `type:"map"` - // The name of the forecast. - ForecastName *string `min:"1" type:"string"` + // The format of the imported data, CSV or PARQUET. + Format *string `type:"string"` - // The quantiles at which probabilistic forecasts were generated. - ForecastTypes []*string `min:"1" type:"list"` + // 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: @@ -11215,25 +12309,32 @@ type DescribeForecastOutput struct { // If an error occurred, an informational message about the error. Message *string `type:"string"` - // The ARN of the predictor used to generate the forecast. - PredictorArn *string `type:"string"` - - // The status of the forecast. States include: + // The status of the dataset import job. States include: // // * ACTIVE // // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED // - // * CREATE_STOPPING, CREATE_STOPPED - // // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED // - // The Status of the forecast must be ACTIVE before you can query or export - // the forecast. + // * CREATE_STOPPING, CREATE_STOPPED Status *string `type:"string"` - // The time series to include in the forecast. - TimeSeriesSelector *TimeSeriesSelector `type:"structure"` + // 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"` } // String returns the string representation. @@ -11241,7 +12342,7 @@ type DescribeForecastOutput 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 DescribeForecastOutput) String() string { +func (s DescribeDatasetImportJobOutput) String() string { return awsutil.Prettify(s) } @@ -11250,83 +12351,113 @@ func (s DescribeForecastOutput) 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 DescribeForecastOutput) GoString() string { +func (s DescribeDatasetImportJobOutput) GoString() string { return s.String() } // SetCreationTime sets the CreationTime field's value. -func (s *DescribeForecastOutput) SetCreationTime(v time.Time) *DescribeForecastOutput { +func (s *DescribeDatasetImportJobOutput) SetCreationTime(v time.Time) *DescribeDatasetImportJobOutput { s.CreationTime = &v return s } -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *DescribeForecastOutput) SetDatasetGroupArn(v string) *DescribeForecastOutput { - s.DatasetGroupArn = &v +// 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 return s } // SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value. -func (s *DescribeForecastOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeForecastOutput { +func (s *DescribeDatasetImportJobOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeDatasetImportJobOutput { s.EstimatedTimeRemainingInMinutes = &v return s } -// SetForecastArn sets the ForecastArn field's value. -func (s *DescribeForecastOutput) SetForecastArn(v string) *DescribeForecastOutput { - s.ForecastArn = &v +// SetFieldStatistics sets the FieldStatistics field's value. +func (s *DescribeDatasetImportJobOutput) SetFieldStatistics(v map[string]*Statistics) *DescribeDatasetImportJobOutput { + s.FieldStatistics = v return s } -// SetForecastName sets the ForecastName field's value. -func (s *DescribeForecastOutput) SetForecastName(v string) *DescribeForecastOutput { - s.ForecastName = &v +// SetFormat sets the Format field's value. +func (s *DescribeDatasetImportJobOutput) SetFormat(v string) *DescribeDatasetImportJobOutput { + s.Format = &v return s } -// SetForecastTypes sets the ForecastTypes field's value. -func (s *DescribeForecastOutput) SetForecastTypes(v []*string) *DescribeForecastOutput { - s.ForecastTypes = v +// SetGeolocationFormat sets the GeolocationFormat field's value. +func (s *DescribeDatasetImportJobOutput) SetGeolocationFormat(v string) *DescribeDatasetImportJobOutput { + s.GeolocationFormat = &v return s } // SetLastModificationTime sets the LastModificationTime field's value. -func (s *DescribeForecastOutput) SetLastModificationTime(v time.Time) *DescribeForecastOutput { +func (s *DescribeDatasetImportJobOutput) SetLastModificationTime(v time.Time) *DescribeDatasetImportJobOutput { s.LastModificationTime = &v return s } // SetMessage sets the Message field's value. -func (s *DescribeForecastOutput) SetMessage(v string) *DescribeForecastOutput { +func (s *DescribeDatasetImportJobOutput) SetMessage(v string) *DescribeDatasetImportJobOutput { s.Message = &v return s } -// SetPredictorArn sets the PredictorArn field's value. -func (s *DescribeForecastOutput) SetPredictorArn(v string) *DescribeForecastOutput { - s.PredictorArn = &v +// SetStatus sets the Status field's value. +func (s *DescribeDatasetImportJobOutput) SetStatus(v string) *DescribeDatasetImportJobOutput { + s.Status = &v return s } -// SetStatus sets the Status field's value. -func (s *DescribeForecastOutput) SetStatus(v string) *DescribeForecastOutput { - s.Status = &v +// SetTimeZone sets the TimeZone field's value. +func (s *DescribeDatasetImportJobOutput) SetTimeZone(v string) *DescribeDatasetImportJobOutput { + s.TimeZone = &v return s } -// SetTimeSeriesSelector sets the TimeSeriesSelector field's value. -func (s *DescribeForecastOutput) SetTimeSeriesSelector(v *TimeSeriesSelector) *DescribeForecastOutput { - s.TimeSeriesSelector = v +// SetTimestampFormat sets the TimestampFormat field's value. +func (s *DescribeDatasetImportJobOutput) SetTimestampFormat(v string) *DescribeDatasetImportJobOutput { + s.TimestampFormat = &v return s } -type DescribeMonitorInput struct { +// SetUseGeolocationForTimeZone sets the UseGeolocationForTimeZone field's value. +func (s *DescribeDatasetImportJobOutput) SetUseGeolocationForTimeZone(v bool) *DescribeDatasetImportJobOutput { + s.UseGeolocationForTimeZone = &v + return s +} + +type DescribeDatasetInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the monitor resource to describe. + // The Amazon Resource Name (ARN) of the dataset. // - // MonitorArn is a required field - MonitorArn *string `type:"string" required:"true"` + // DatasetArn is a required field + DatasetArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -11334,7 +12465,7 @@ type DescribeMonitorInput 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 DescribeMonitorInput) String() string { +func (s DescribeDatasetInput) String() string { return awsutil.Prettify(s) } @@ -11343,15 +12474,15 @@ func (s DescribeMonitorInput) 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 DescribeMonitorInput) 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 *DescribeMonitorInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribeMonitorInput"} - if s.MonitorArn == nil { - invalidParams.Add(request.NewErrParamRequired("MonitorArn")) +func (s *DescribeDatasetInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDatasetInput"} + if s.DatasetArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetArn")) } if invalidParams.Len() > 0 { @@ -11360,48 +12491,71 @@ func (s *DescribeMonitorInput) Validate() error { return nil } -// SetMonitorArn sets the MonitorArn field's value. -func (s *DescribeMonitorInput) SetMonitorArn(v string) *DescribeMonitorInput { - s.MonitorArn = &v +// SetDatasetArn sets the DatasetArn field's value. +func (s *DescribeDatasetInput) SetDatasetArn(v string) *DescribeDatasetInput { + s.DatasetArn = &v return s } -type DescribeMonitorOutput struct { +type DescribeDatasetOutput struct { _ struct{} `type:"structure"` - // Metrics you can use as a baseline for comparison purposes. Use these values - // you interpret monitoring results for an auto predictor. - Baseline *Baseline `type:"structure"` - - // The timestamp for when the monitor resource was created. + // When the dataset was created. CreationTime *time.Time `type:"timestamp"` - // The estimated number of minutes remaining before the monitor resource finishes - // its current evaluation. - EstimatedEvaluationTimeRemainingInMinutes *int64 `type:"long"` + // 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 state of the monitor's latest evaluation. - LastEvaluationState *string `type:"string"` + // The Amazon Resource Name (ARN) of the dataset. + DatasetArn *string `type:"string"` - // The timestamp of the latest evaluation completed by the monitor. - LastEvaluationTime *time.Time `type:"timestamp"` + // The name of the dataset. + DatasetName *string `min:"1" type:"string"` - // The timestamp of the latest modification to the monitor. - LastModificationTime *time.Time `type:"timestamp"` + // The dataset type. + DatasetType *string `type:"string" enum:"DatasetType"` - // An error message, if any, for the monitor. - Message *string `type:"string"` + // The domain associated with the dataset. + Domain *string `type:"string" enum:"Domain"` - // The Amazon Resource Name (ARN) of the monitor resource described. - MonitorArn *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 name of the monitor. - MonitorName *string `min:"1" type:"string"` + // When you create a dataset, LastModificationTime is the same as CreationTime. + // While data is being imported to the dataset, LastModificationTime is the + // current time of the DescribeDataset call. After a CreateDatasetImportJob + // (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) + // operation has finished, LastModificationTime is when the import job completed + // or failed. + LastModificationTime *time.Time `type:"timestamp"` - // The Amazon Resource Name (ARN) of the auto predictor being monitored. - ResourceArn *string `type:"string"` + // 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 monitor resource. + // The status of the dataset. 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 (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) + // 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. Status *string `type:"string"` } @@ -11410,7 +12564,7 @@ type DescribeMonitorOutput 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 DescribeMonitorOutput) String() string { +func (s DescribeDatasetOutput) String() string { return awsutil.Prettify(s) } @@ -11419,83 +12573,77 @@ func (s DescribeMonitorOutput) 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 DescribeMonitorOutput) GoString() string { +func (s DescribeDatasetOutput) GoString() string { return s.String() } -// SetBaseline sets the Baseline field's value. -func (s *DescribeMonitorOutput) SetBaseline(v *Baseline) *DescribeMonitorOutput { - s.Baseline = v - return s -} - // SetCreationTime sets the CreationTime field's value. -func (s *DescribeMonitorOutput) SetCreationTime(v time.Time) *DescribeMonitorOutput { +func (s *DescribeDatasetOutput) SetCreationTime(v time.Time) *DescribeDatasetOutput { s.CreationTime = &v return s } -// SetEstimatedEvaluationTimeRemainingInMinutes sets the EstimatedEvaluationTimeRemainingInMinutes field's value. -func (s *DescribeMonitorOutput) SetEstimatedEvaluationTimeRemainingInMinutes(v int64) *DescribeMonitorOutput { - s.EstimatedEvaluationTimeRemainingInMinutes = &v +// SetDataFrequency sets the DataFrequency field's value. +func (s *DescribeDatasetOutput) SetDataFrequency(v string) *DescribeDatasetOutput { + s.DataFrequency = &v return s } -// SetLastEvaluationState sets the LastEvaluationState field's value. -func (s *DescribeMonitorOutput) SetLastEvaluationState(v string) *DescribeMonitorOutput { - s.LastEvaluationState = &v +// SetDatasetArn sets the DatasetArn field's value. +func (s *DescribeDatasetOutput) SetDatasetArn(v string) *DescribeDatasetOutput { + s.DatasetArn = &v return s } -// SetLastEvaluationTime sets the LastEvaluationTime field's value. -func (s *DescribeMonitorOutput) SetLastEvaluationTime(v time.Time) *DescribeMonitorOutput { - s.LastEvaluationTime = &v +// SetDatasetName sets the DatasetName field's value. +func (s *DescribeDatasetOutput) SetDatasetName(v string) *DescribeDatasetOutput { + s.DatasetName = &v return s } -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *DescribeMonitorOutput) SetLastModificationTime(v time.Time) *DescribeMonitorOutput { - s.LastModificationTime = &v +// SetDatasetType sets the DatasetType field's value. +func (s *DescribeDatasetOutput) SetDatasetType(v string) *DescribeDatasetOutput { + s.DatasetType = &v return s } -// SetMessage sets the Message field's value. -func (s *DescribeMonitorOutput) SetMessage(v string) *DescribeMonitorOutput { - s.Message = &v +// SetDomain sets the Domain field's value. +func (s *DescribeDatasetOutput) SetDomain(v string) *DescribeDatasetOutput { + s.Domain = &v return s } -// SetMonitorArn sets the MonitorArn field's value. -func (s *DescribeMonitorOutput) SetMonitorArn(v string) *DescribeMonitorOutput { - s.MonitorArn = &v +// SetEncryptionConfig sets the EncryptionConfig field's value. +func (s *DescribeDatasetOutput) SetEncryptionConfig(v *EncryptionConfig) *DescribeDatasetOutput { + s.EncryptionConfig = v return s } -// SetMonitorName sets the MonitorName field's value. -func (s *DescribeMonitorOutput) SetMonitorName(v string) *DescribeMonitorOutput { - s.MonitorName = &v +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DescribeDatasetOutput) SetLastModificationTime(v time.Time) *DescribeDatasetOutput { + s.LastModificationTime = &v return s } -// SetResourceArn sets the ResourceArn field's value. -func (s *DescribeMonitorOutput) SetResourceArn(v string) *DescribeMonitorOutput { - s.ResourceArn = &v +// 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 *DescribeMonitorOutput) SetStatus(v string) *DescribeMonitorOutput { +func (s *DescribeDatasetOutput) SetStatus(v string) *DescribeDatasetOutput { s.Status = &v return s } -type DescribePredictorBacktestExportJobInput struct { +type DescribeExplainabilityExportInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the predictor backtest export job. + // The Amazon Resource Name (ARN) of the Explainability export. // - // PredictorBacktestExportJobArn is a required field - PredictorBacktestExportJobArn *string `type:"string" required:"true"` + // ExplainabilityExportArn is a required field + ExplainabilityExportArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -11503,7 +12651,7 @@ type DescribePredictorBacktestExportJobInput 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 DescribePredictorBacktestExportJobInput) String() string { +func (s DescribeExplainabilityExportInput) String() string { return awsutil.Prettify(s) } @@ -11512,15 +12660,15 @@ func (s DescribePredictorBacktestExportJobInput) 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 DescribePredictorBacktestExportJobInput) 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 *DescribePredictorBacktestExportJobInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribePredictorBacktestExportJobInput"} - if s.PredictorBacktestExportJobArn == nil { - invalidParams.Add(request.NewErrParamRequired("PredictorBacktestExportJobArn")) +func (s *DescribeExplainabilityExportInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeExplainabilityExportInput"} + if s.ExplainabilityExportArn == nil { + invalidParams.Add(request.NewErrParamRequired("ExplainabilityExportArn")) } if invalidParams.Len() > 0 { @@ -11529,16 +12677,16 @@ func (s *DescribePredictorBacktestExportJobInput) Validate() error { return nil } -// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value. -func (s *DescribePredictorBacktestExportJobInput) SetPredictorBacktestExportJobArn(v string) *DescribePredictorBacktestExportJobInput { - s.PredictorBacktestExportJobArn = &v +// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value. +func (s *DescribeExplainabilityExportInput) SetExplainabilityExportArn(v string) *DescribeExplainabilityExportInput { + s.ExplainabilityExportArn = &v return s } -type DescribePredictorBacktestExportJobOutput struct { +type DescribeExplainabilityExportOutput struct { _ struct{} `type:"structure"` - // When the predictor backtest export job was created. + // When the Explainability export was created. CreationTime *time.Time `type:"timestamp"` // The destination for an export job. Provide an S3 path, an AWS Identity and @@ -11546,6 +12694,15 @@ type DescribePredictorBacktestExportJobOutput struct { // and an AWS Key Management Service (KMS) key (optional). Destination *DataDestination `type:"structure"` + // The Amazon Resource Name (ARN) of the Explainability export. + ExplainabilityArn *string `type:"string"` + + // 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 format of the exported data, CSV or PARQUET. Format *string `type:"string"` @@ -11563,19 +12720,10 @@ type DescribePredictorBacktestExportJobOutput struct { // * ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time `type:"timestamp"` - // Information about any errors that may have occurred during the backtest export. + // Information about any errors that occurred during the export. Message *string `type:"string"` - // The Amazon Resource Name (ARN) of the predictor. - PredictorArn *string `type:"string"` - - // The Amazon Resource Name (ARN) of the predictor backtest export job. - PredictorBacktestExportJobArn *string `type:"string"` - - // The name of the predictor backtest export job. - PredictorBacktestExportJobName *string `min:"1" type:"string"` - - // The status of the predictor backtest export job. States include: + // The status of the Explainability export. States include: // // * ACTIVE // @@ -11592,7 +12740,7 @@ type DescribePredictorBacktestExportJobOutput 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 DescribePredictorBacktestExportJobOutput) String() string { +func (s DescribeExplainabilityExportOutput) String() string { return awsutil.Prettify(s) } @@ -11601,72 +12749,71 @@ func (s DescribePredictorBacktestExportJobOutput) 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 DescribePredictorBacktestExportJobOutput) GoString() string { +func (s DescribeExplainabilityExportOutput) GoString() string { return s.String() } // SetCreationTime sets the CreationTime field's value. -func (s *DescribePredictorBacktestExportJobOutput) SetCreationTime(v time.Time) *DescribePredictorBacktestExportJobOutput { +func (s *DescribeExplainabilityExportOutput) SetCreationTime(v time.Time) *DescribeExplainabilityExportOutput { s.CreationTime = &v return s } // SetDestination sets the Destination field's value. -func (s *DescribePredictorBacktestExportJobOutput) SetDestination(v *DataDestination) *DescribePredictorBacktestExportJobOutput { +func (s *DescribeExplainabilityExportOutput) SetDestination(v *DataDestination) *DescribeExplainabilityExportOutput { s.Destination = v return s } -// SetFormat sets the Format field's value. -func (s *DescribePredictorBacktestExportJobOutput) SetFormat(v string) *DescribePredictorBacktestExportJobOutput { - s.Format = &v +// SetExplainabilityArn sets the ExplainabilityArn field's value. +func (s *DescribeExplainabilityExportOutput) SetExplainabilityArn(v string) *DescribeExplainabilityExportOutput { + s.ExplainabilityArn = &v return s } -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *DescribePredictorBacktestExportJobOutput) SetLastModificationTime(v time.Time) *DescribePredictorBacktestExportJobOutput { - s.LastModificationTime = &v +// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value. +func (s *DescribeExplainabilityExportOutput) SetExplainabilityExportArn(v string) *DescribeExplainabilityExportOutput { + s.ExplainabilityExportArn = &v return s } -// SetMessage sets the Message field's value. -func (s *DescribePredictorBacktestExportJobOutput) SetMessage(v string) *DescribePredictorBacktestExportJobOutput { - s.Message = &v +// SetExplainabilityExportName sets the ExplainabilityExportName field's value. +func (s *DescribeExplainabilityExportOutput) SetExplainabilityExportName(v string) *DescribeExplainabilityExportOutput { + s.ExplainabilityExportName = &v return s } -// SetPredictorArn sets the PredictorArn field's value. -func (s *DescribePredictorBacktestExportJobOutput) SetPredictorArn(v string) *DescribePredictorBacktestExportJobOutput { - s.PredictorArn = &v +// SetFormat sets the Format field's value. +func (s *DescribeExplainabilityExportOutput) SetFormat(v string) *DescribeExplainabilityExportOutput { + s.Format = &v return s } -// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value. -func (s *DescribePredictorBacktestExportJobOutput) SetPredictorBacktestExportJobArn(v string) *DescribePredictorBacktestExportJobOutput { - s.PredictorBacktestExportJobArn = &v +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DescribeExplainabilityExportOutput) SetLastModificationTime(v time.Time) *DescribeExplainabilityExportOutput { + s.LastModificationTime = &v return s } -// SetPredictorBacktestExportJobName sets the PredictorBacktestExportJobName field's value. -func (s *DescribePredictorBacktestExportJobOutput) SetPredictorBacktestExportJobName(v string) *DescribePredictorBacktestExportJobOutput { - s.PredictorBacktestExportJobName = &v +// SetMessage sets the Message field's value. +func (s *DescribeExplainabilityExportOutput) SetMessage(v string) *DescribeExplainabilityExportOutput { + s.Message = &v return s } // SetStatus sets the Status field's value. -func (s *DescribePredictorBacktestExportJobOutput) SetStatus(v string) *DescribePredictorBacktestExportJobOutput { +func (s *DescribeExplainabilityExportOutput) SetStatus(v string) *DescribeExplainabilityExportOutput { s.Status = &v return s } -type DescribePredictorInput struct { +type DescribeExplainabilityInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the predictor that you want information - // about. + // The Amazon Resource Name (ARN) of the Explaianability to describe. // - // PredictorArn is a required field - PredictorArn *string `type:"string" required:"true"` + // ExplainabilityArn is a required field + ExplainabilityArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -11674,7 +12821,7 @@ type DescribePredictorInput 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 DescribePredictorInput) String() string { +func (s DescribeExplainabilityInput) String() string { return awsutil.Prettify(s) } @@ -11683,15 +12830,15 @@ func (s DescribePredictorInput) 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 DescribePredictorInput) 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 *DescribePredictorInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DescribePredictorInput"} - if s.PredictorArn == nil { - invalidParams.Add(request.NewErrParamRequired("PredictorArn")) +func (s *DescribeExplainabilityInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeExplainabilityInput"} + if s.ExplainabilityArn == nil { + invalidParams.Add(request.NewErrParamRequired("ExplainabilityArn")) } if invalidParams.Len() > 0 { @@ -11700,71 +12847,42 @@ func (s *DescribePredictorInput) Validate() error { return nil } -// SetPredictorArn sets the PredictorArn field's value. -func (s *DescribePredictorInput) SetPredictorArn(v string) *DescribePredictorInput { - s.PredictorArn = &v +// SetExplainabilityArn sets the ExplainabilityArn field's value. +func (s *DescribeExplainabilityInput) SetExplainabilityArn(v string) *DescribeExplainabilityInput { + s.ExplainabilityArn = &v return s } -type DescribePredictorOutput struct { +type DescribeExplainabilityOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the algorithm used for model training. - AlgorithmArn *string `type:"string"` - - // When PerformAutoML is specified, the ARN of the chosen algorithm. - AutoMLAlgorithmArns []*string `type:"list"` - - // - // The LatencyOptimized AutoML override strategy is only available in private - // beta. Contact AWS Support or your account manager to learn more about access - // privileges. - // - // The AutoML strategy used to train the predictor. Unless LatencyOptimized - // is specified, the AutoML strategy optimizes predictor accuracy. - // - // This parameter is only valid for predictors trained using AutoML. - AutoMLOverrideStrategy *string `type:"string" enum:"AutoMLOverrideStrategy"` - - // When the model training task was created. + // When the Explainability resource was created. CreationTime *time.Time `type:"timestamp"` - // 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 the AWS Identity and Access Management - // (IAM) role that Amazon Forecast can assume to access the key. - EncryptionConfig *EncryptionConfig `type:"structure"` - - // The estimated time remaining in minutes for the predictor training job to - // complete. - EstimatedTimeRemainingInMinutes *int64 `type:"long"` - - // 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 source of your 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. + DataSource *DataSource `type:"structure"` - // The featurization configuration. - FeaturizationConfig *FeaturizationConfig `type:"structure"` + // Whether the visualization was enabled for the Explainability resource. + EnableVisualization *bool `type:"boolean"` - // The number of time-steps of the forecast. The forecast horizon is also called - // the prediction length. - ForecastHorizon *int64 `type:"integer"` + // If TimePointGranularity is set to SPECIFIC, the last time point in the Explainability. + EndDateTime *string `type:"string"` - // The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"] - ForecastTypes []*string `min:"1" type:"list"` + // The estimated time remaining in minutes for the CreateExplainability job + // to complete. + EstimatedTimeRemainingInMinutes *int64 `type:"long"` - // The hyperparameter override values for the algorithm. - HPOConfig *HyperParameterTuningJobConfig `type:"structure"` + // The Amazon Resource Name (ARN) of the Explainability. + ExplainabilityArn *string `type:"string"` - // Describes the dataset group that contains the data to use to train the predictor. - InputDataConfig *InputDataConfig `type:"structure"` + // The configuration settings that define the granularity of time series and + // time points for the Explainability. + ExplainabilityConfig *ExplainabilityConfig `type:"structure"` - // Whether the predictor was created with CreateAutoPredictor. - IsAutoPredictor *bool `type:"boolean"` + // 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: @@ -11780,48 +12898,29 @@ type DescribePredictorOutput 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. + // If an error occurred, a message about the error. Message *string `type:"string"` - // The accuracy metric used to optimize the predictor. - OptimizationMetric *string `type:"string" enum:"OptimizationMetric"` - - // Whether the predictor is set to perform AutoML. - PerformAutoML *bool `type:"boolean"` - - // Whether the predictor is set to perform hyperparameter optimization (HPO). - PerformHPO *bool `type:"boolean"` - - // The ARN of the predictor. - PredictorArn *string `min:"1" type:"string"` + // The Amazon Resource Name (ARN) of the Predictor or Forecast used to create + // the Explainability resource. + ResourceArn *string `type:"string"` - // Details on the the status and results of the backtests performed to evaluate - // the accuracy of the predictor. You specify the number of backtests to perform - // when you call the operation. - PredictorExecutionDetails *PredictorExecutionDetails `type:"structure"` + // Defines the fields of a dataset. + Schema *Schema `type:"structure"` - // The name of the predictor. - PredictorName *string `min:"1" type:"string"` + // If TimePointGranularity is set to SPECIFIC, the first time point in the Explainability. + StartDateTime *string `type:"string"` - // The status of the predictor. States include: + // The status of the Explainability resource. States include: // // * ACTIVE // // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - // // * CREATE_STOPPING, CREATE_STOPPED // - // The Status of the predictor must be ACTIVE before you can use the predictor - // to create a forecast. + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED 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"` } // String returns the string representation. @@ -11829,7 +12928,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 DescribeExplainabilityOutput) String() string { return awsutil.Prettify(s) } @@ -11838,173 +12937,101 @@ 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 DescribeExplainabilityOutput) GoString() string { return s.String() } -// SetAlgorithmArn sets the AlgorithmArn field's value. -func (s *DescribePredictorOutput) SetAlgorithmArn(v string) *DescribePredictorOutput { - s.AlgorithmArn = &v +// SetCreationTime sets the CreationTime field's value. +func (s *DescribeExplainabilityOutput) SetCreationTime(v time.Time) *DescribeExplainabilityOutput { + s.CreationTime = &v return s } -// SetAutoMLAlgorithmArns sets the AutoMLAlgorithmArns field's value. -func (s *DescribePredictorOutput) SetAutoMLAlgorithmArns(v []*string) *DescribePredictorOutput { - s.AutoMLAlgorithmArns = v +// SetDataSource sets the DataSource field's value. +func (s *DescribeExplainabilityOutput) SetDataSource(v *DataSource) *DescribeExplainabilityOutput { + s.DataSource = 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 +// SetEnableVisualization sets the EnableVisualization field's value. +func (s *DescribeExplainabilityOutput) SetEnableVisualization(v bool) *DescribeExplainabilityOutput { + s.EnableVisualization = &v return s } -// SetEncryptionConfig sets the EncryptionConfig field's value. -func (s *DescribePredictorOutput) SetEncryptionConfig(v *EncryptionConfig) *DescribePredictorOutput { - s.EncryptionConfig = v +// SetEndDateTime sets the EndDateTime field's value. +func (s *DescribeExplainabilityOutput) SetEndDateTime(v string) *DescribeExplainabilityOutput { + s.EndDateTime = &v return s } // SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value. -func (s *DescribePredictorOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribePredictorOutput { +func (s *DescribeExplainabilityOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeExplainabilityOutput { 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 +// SetExplainabilityArn sets the ExplainabilityArn field's value. +func (s *DescribeExplainabilityOutput) SetExplainabilityArn(v string) *DescribeExplainabilityOutput { + s.ExplainabilityArn = &v return s } -// SetInputDataConfig sets the InputDataConfig field's value. -func (s *DescribePredictorOutput) SetInputDataConfig(v *InputDataConfig) *DescribePredictorOutput { - s.InputDataConfig = v +// SetExplainabilityConfig sets the ExplainabilityConfig field's value. +func (s *DescribeExplainabilityOutput) SetExplainabilityConfig(v *ExplainabilityConfig) *DescribeExplainabilityOutput { + s.ExplainabilityConfig = v return s } -// SetIsAutoPredictor sets the IsAutoPredictor field's value. -func (s *DescribePredictorOutput) SetIsAutoPredictor(v bool) *DescribePredictorOutput { - s.IsAutoPredictor = &v +// 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 *DescribePredictorOutput) SetLastModificationTime(v time.Time) *DescribePredictorOutput { +func (s *DescribeExplainabilityOutput) SetLastModificationTime(v time.Time) *DescribeExplainabilityOutput { s.LastModificationTime = &v return s } // SetMessage sets the Message field's value. -func (s *DescribePredictorOutput) SetMessage(v string) *DescribePredictorOutput { +func (s *DescribeExplainabilityOutput) SetMessage(v string) *DescribeExplainabilityOutput { 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 +// SetResourceArn sets the ResourceArn field's value. +func (s *DescribeExplainabilityOutput) SetResourceArn(v string) *DescribeExplainabilityOutput { + s.ResourceArn = &v return s } -// SetPredictorExecutionDetails sets the PredictorExecutionDetails field's value. -func (s *DescribePredictorOutput) SetPredictorExecutionDetails(v *PredictorExecutionDetails) *DescribePredictorOutput { - s.PredictorExecutionDetails = v +// SetSchema sets the Schema field's value. +func (s *DescribeExplainabilityOutput) SetSchema(v *Schema) *DescribeExplainabilityOutput { + s.Schema = v return s } -// SetPredictorName sets the PredictorName field's value. -func (s *DescribePredictorOutput) SetPredictorName(v string) *DescribePredictorOutput { - s.PredictorName = &v +// 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 *DescribePredictorOutput) SetStatus(v string) *DescribePredictorOutput { +func (s *DescribeExplainabilityOutput) SetStatus(v string) *DescribeExplainabilityOutput { 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 { +type DescribeForecastExportJobInput 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. + // The Amazon Resource Name (ARN) of the forecast export job. // - // RoleArn is a required field - RoleArn *string `type:"string" required:"true"` + // ForecastExportJobArn is a required field + ForecastExportJobArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -12012,7 +13039,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 DescribeForecastExportJobInput) String() string { return awsutil.Prettify(s) } @@ -12021,18 +13048,15 @@ 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 DescribeForecastExportJobInput) 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")) +func (s *DescribeForecastExportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeForecastExportJobInput"} + if s.ForecastExportJobArn == nil { + invalidParams.Add(request.NewErrParamRequired("ForecastExportJobArn")) } if invalidParams.Len() > 0 { @@ -12041,37 +13065,64 @@ func (s *EncryptionConfig) Validate() error { 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 +// SetForecastExportJobArn sets the ForecastExportJobArn field's value. +func (s *DescribeForecastExportJobInput) SetForecastExportJobArn(v string) *DescribeForecastExportJobInput { + s.ForecastExportJobArn = &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 { +type DescribeForecastExportJobOutput struct { _ struct{} `type:"structure"` - // The Forecast type used to compute WAPE, MAPE, MASE, and RMSE. - ForecastType *string `min:"2" type:"string"` + // When the forecast export job was created. + CreationTime *time.Time `type:"timestamp"` - // The Mean Absolute Percentage Error (MAPE) - MAPE *float64 `type:"double"` + // The path to the Amazon Simple Storage Service (Amazon S3) bucket where the + // forecast is exported. + Destination *DataDestination `type:"structure"` - // The Mean Absolute Scaled Error (MASE) - MASE *float64 `type:"double"` + // The Amazon Resource Name (ARN) of the exported forecast. + ForecastArn *string `type:"string"` - // The root-mean-square error (RMSE). - RMSE *float64 `type:"double"` + // The ARN of the forecast export job. + ForecastExportJobArn *string `type:"string"` - // The weighted absolute percentage error (WAPE). - WAPE *float64 `type:"double"` + // The name of the forecast export job. + ForecastExportJobName *string `min:"1" type:"string"` + + // The format of the exported data, CSV or PARQUET. + Format *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 forecast export job. States include: + // + // * ACTIVE + // + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * CREATE_STOPPING, CREATE_STOPPED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // + // The Status of the forecast export job must be ACTIVE before you can access + // the forecast in your S3 bucket. + Status *string `type:"string"` } // String returns the string representation. @@ -12079,7 +13130,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 DescribeForecastExportJobOutput) String() string { return awsutil.Prettify(s) } @@ -12088,168 +13139,71 @@ 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 DescribeForecastExportJobOutput) GoString() string { return s.String() } -// SetForecastType sets the ForecastType field's value. -func (s *ErrorMetric) SetForecastType(v string) *ErrorMetric { - s.ForecastType = &v +// SetCreationTime sets the CreationTime field's value. +func (s *DescribeForecastExportJobOutput) SetCreationTime(v time.Time) *DescribeForecastExportJobOutput { + s.CreationTime = &v return s } -// SetMAPE sets the MAPE field's value. -func (s *ErrorMetric) SetMAPE(v float64) *ErrorMetric { - s.MAPE = &v +// SetDestination sets the Destination field's value. +func (s *DescribeForecastExportJobOutput) SetDestination(v *DataDestination) *DescribeForecastExportJobOutput { + s.Destination = v return s } -// SetMASE sets the MASE field's value. -func (s *ErrorMetric) SetMASE(v float64) *ErrorMetric { - s.MASE = &v +// SetForecastArn sets the ForecastArn field's value. +func (s *DescribeForecastExportJobOutput) SetForecastArn(v string) *DescribeForecastExportJobOutput { + s.ForecastArn = &v return s } -// SetRMSE sets the RMSE field's value. -func (s *ErrorMetric) SetRMSE(v float64) *ErrorMetric { - s.RMSE = &v +// SetForecastExportJobArn sets the ForecastExportJobArn field's value. +func (s *DescribeForecastExportJobOutput) SetForecastExportJobArn(v string) *DescribeForecastExportJobOutput { + s.ForecastExportJobArn = &v return s } -// SetWAPE sets the WAPE field's value. -func (s *ErrorMetric) SetWAPE(v float64) *ErrorMetric { - s.WAPE = &v +// SetForecastExportJobName sets the ForecastExportJobName field's value. +func (s *DescribeForecastExportJobOutput) SetForecastExportJobName(v string) *DescribeForecastExportJobOutput { + s.ForecastExportJobName = &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"` - - // 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"` - - // The number of times to split the input data. The default is 1. Valid values - // are 1 through 5. - NumberOfBacktestWindows *int64 `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 EvaluationParameters) 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 EvaluationParameters) GoString() string { - return s.String() -} - -// SetBackTestWindowOffset sets the BackTestWindowOffset field's value. -func (s *EvaluationParameters) SetBackTestWindowOffset(v int64) *EvaluationParameters { - s.BackTestWindowOffset = &v +// SetFormat sets the Format field's value. +func (s *DescribeForecastExportJobOutput) SetFormat(v string) *DescribeForecastExportJobOutput { + s.Format = &v return s } -// SetNumberOfBacktestWindows sets the NumberOfBacktestWindows field's value. -func (s *EvaluationParameters) SetNumberOfBacktestWindows(v int64) *EvaluationParameters { - s.NumberOfBacktestWindows = &v +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DescribeForecastExportJobOutput) SetLastModificationTime(v time.Time) *DescribeForecastExportJobOutput { + s.LastModificationTime = &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"` -} - -// 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) -} - -// 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() -} - -// SetAlgorithmArn sets the AlgorithmArn field's value. -func (s *EvaluationResult) SetAlgorithmArn(v string) *EvaluationResult { - s.AlgorithmArn = &v +// SetMessage sets the Message field's value. +func (s *DescribeForecastExportJobOutput) SetMessage(v string) *DescribeForecastExportJobOutput { + s.Message = &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 *DescribeForecastExportJobOutput) SetStatus(v string) *DescribeForecastExportJobOutput { + s.Status = &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 { +type DescribeForecastInput 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 or Parquet file to an Amazon S3 bucket - // and set the location within the DataDestination data type. + // The Amazon Resource Name (ARN) of the forecast. // - // TimeSeriesGranularity is a required field - TimeSeriesGranularity *string `type:"string" required:"true" enum:"TimeSeriesGranularity"` + // ForecastArn is a required field + ForecastArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -12257,7 +13211,7 @@ type ExplainabilityConfig 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 ExplainabilityConfig) String() string { +func (s DescribeForecastInput) String() string { return awsutil.Prettify(s) } @@ -12266,18 +13220,15 @@ func (s ExplainabilityConfig) 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 ExplainabilityConfig) GoString() string { +func (s DescribeForecastInput) GoString() string { return s.String() } // 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")) +func (s *DescribeForecastInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeForecastInput"} + if s.ForecastArn == nil { + invalidParams.Add(request.NewErrParamRequired("ForecastArn")) } if invalidParams.Len() > 0 { @@ -12286,37 +13237,32 @@ func (s *ExplainabilityConfig) Validate() error { return nil } -// SetTimePointGranularity sets the TimePointGranularity field's value. -func (s *ExplainabilityConfig) SetTimePointGranularity(v string) *ExplainabilityConfig { - s.TimePointGranularity = &v - return s -} - -// SetTimeSeriesGranularity sets the TimeSeriesGranularity field's value. -func (s *ExplainabilityConfig) SetTimeSeriesGranularity(v string) *ExplainabilityConfig { - s.TimeSeriesGranularity = &v +// SetForecastArn sets the ForecastArn field's value. +func (s *DescribeForecastInput) SetForecastArn(v string) *DescribeForecastInput { + s.ForecastArn = &v return s } -// 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 { +type DescribeForecastOutput struct { _ struct{} `type:"structure"` - // When the Explainability was created. + // When the forecast creation task 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 ARN of the dataset group that provided the data used to train the predictor. + DatasetGroupArn *string `type:"string"` - // The Amazon Resource Name (ARN) of the Explainability export. - ExplainabilityExportArn *string `type:"string"` + // The estimated time remaining in minutes for the forecast job to complete. + EstimatedTimeRemainingInMinutes *int64 `type:"long"` - // The name of the Explainability export - ExplainabilityExportName *string `min:"1" type:"string"` + // The forecast ARN as specified in the request. + ForecastArn *string `type:"string"` + + // The name of the forecast. + ForecastName *string `min:"1" type:"string"` + + // The quantiles at which probabilistic forecasts were generated. + ForecastTypes []*string `min:"1" type:"list"` // The last time the resource was modified. The timestamp depends on the status // of the job: @@ -12332,11 +13278,13 @@ type ExplainabilityExportSummary struct { // * ACTIVE or CREATE_FAILED - When the job finished or failed. LastModificationTime *time.Time `type:"timestamp"` - // Information about any errors that may have occurred during the Explainability - // export. + // If an error occurred, an informational message about the error. Message *string `type:"string"` - // The status of the Explainability export. States include: + // The ARN of the predictor used to generate the forecast. + PredictorArn *string `type:"string"` + + // The status of the forecast. States include: // // * ACTIVE // @@ -12345,7 +13293,13 @@ type ExplainabilityExportSummary struct { // * CREATE_STOPPING, CREATE_STOPPED // // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // + // The Status of the forecast must be ACTIVE before you can query or export + // the forecast. Status *string `type:"string"` + + // The time series to include in the forecast. + TimeSeriesSelector *TimeSeriesSelector `type:"structure"` } // String returns the string representation. @@ -12353,7 +13307,7 @@ type ExplainabilityExportSummary 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 ExplainabilityExportSummary) String() string { +func (s DescribeForecastOutput) String() string { return awsutil.Prettify(s) } @@ -12362,69 +13316,83 @@ func (s ExplainabilityExportSummary) 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 ExplainabilityExportSummary) GoString() string { +func (s DescribeForecastOutput) GoString() string { return s.String() } // SetCreationTime sets the CreationTime field's value. -func (s *ExplainabilityExportSummary) SetCreationTime(v time.Time) *ExplainabilityExportSummary { +func (s *DescribeForecastOutput) SetCreationTime(v time.Time) *DescribeForecastOutput { s.CreationTime = &v return s } -// SetDestination sets the Destination field's value. -func (s *ExplainabilityExportSummary) SetDestination(v *DataDestination) *ExplainabilityExportSummary { - s.Destination = v +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *DescribeForecastOutput) SetDatasetGroupArn(v string) *DescribeForecastOutput { + s.DatasetGroupArn = &v return s } -// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value. -func (s *ExplainabilityExportSummary) SetExplainabilityExportArn(v string) *ExplainabilityExportSummary { - s.ExplainabilityExportArn = &v +// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value. +func (s *DescribeForecastOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeForecastOutput { + s.EstimatedTimeRemainingInMinutes = &v return s } -// SetExplainabilityExportName sets the ExplainabilityExportName field's value. -func (s *ExplainabilityExportSummary) SetExplainabilityExportName(v string) *ExplainabilityExportSummary { - s.ExplainabilityExportName = &v +// SetForecastArn sets the ForecastArn field's value. +func (s *DescribeForecastOutput) SetForecastArn(v string) *DescribeForecastOutput { + s.ForecastArn = &v + return s +} + +// SetForecastName sets the ForecastName field's value. +func (s *DescribeForecastOutput) SetForecastName(v string) *DescribeForecastOutput { + s.ForecastName = &v + return s +} + +// SetForecastTypes sets the ForecastTypes field's value. +func (s *DescribeForecastOutput) SetForecastTypes(v []*string) *DescribeForecastOutput { + s.ForecastTypes = v return s } // SetLastModificationTime sets the LastModificationTime field's value. -func (s *ExplainabilityExportSummary) SetLastModificationTime(v time.Time) *ExplainabilityExportSummary { +func (s *DescribeForecastOutput) SetLastModificationTime(v time.Time) *DescribeForecastOutput { s.LastModificationTime = &v return s } // SetMessage sets the Message field's value. -func (s *ExplainabilityExportSummary) SetMessage(v string) *ExplainabilityExportSummary { +func (s *DescribeForecastOutput) SetMessage(v string) *DescribeForecastOutput { s.Message = &v return s } +// SetPredictorArn sets the PredictorArn field's value. +func (s *DescribeForecastOutput) SetPredictorArn(v string) *DescribeForecastOutput { + s.PredictorArn = &v + return s +} + // SetStatus sets the Status field's value. -func (s *ExplainabilityExportSummary) SetStatus(v string) *ExplainabilityExportSummary { +func (s *DescribeForecastOutput) SetStatus(v string) *DescribeForecastOutput { s.Status = &v return s } -// Provides information about the Explainability resource. -type ExplainabilityInfo struct { - _ struct{} `type:"structure"` +// SetTimeSeriesSelector sets the TimeSeriesSelector field's value. +func (s *DescribeForecastOutput) SetTimeSeriesSelector(v *TimeSeriesSelector) *DescribeForecastOutput { + s.TimeSeriesSelector = v + return s +} - // The Amazon Resource Name (ARN) of the Explainability. - ExplainabilityArn *string `type:"string"` +type DescribeMonitorInput struct { + _ struct{} `type:"structure"` - // The status of the Explainability. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED + // The Amazon Resource Name (ARN) of the monitor resource to describe. // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - Status *string `type:"string"` + // MonitorArn is a required field + MonitorArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -12432,7 +13400,7 @@ type ExplainabilityInfo 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 ExplainabilityInfo) String() string { +func (s DescribeMonitorInput) String() string { return awsutil.Prettify(s) } @@ -12441,72 +13409,65 @@ func (s ExplainabilityInfo) 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 ExplainabilityInfo) GoString() string { +func (s DescribeMonitorInput) GoString() string { return s.String() } -// SetExplainabilityArn sets the ExplainabilityArn field's value. -func (s *ExplainabilityInfo) SetExplainabilityArn(v string) *ExplainabilityInfo { - s.ExplainabilityArn = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeMonitorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeMonitorInput"} + if s.MonitorArn == nil { + invalidParams.Add(request.NewErrParamRequired("MonitorArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetStatus sets the Status field's value. -func (s *ExplainabilityInfo) SetStatus(v string) *ExplainabilityInfo { - s.Status = &v +// SetMonitorArn sets the MonitorArn field's value. +func (s *DescribeMonitorInput) SetMonitorArn(v string) *DescribeMonitorInput { + s.MonitorArn = &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 { +type DescribeMonitorOutput struct { _ struct{} `type:"structure"` - // When the Explainability was created. + // Metrics you can use as a baseline for comparison purposes. Use these values + // you interpret monitoring results for an auto predictor. + Baseline *Baseline `type:"structure"` + + // The timestamp for when the monitor resource was created. CreationTime *time.Time `type:"timestamp"` - // The Amazon Resource Name (ARN) of the Explainability. - ExplainabilityArn *string `type:"string"` + // The estimated number of minutes remaining before the monitor resource finishes + // its current evaluation. + EstimatedEvaluationTimeRemainingInMinutes *int64 `type:"long"` - // The configuration settings that define the granularity of time series and - // time points for the Explainability. - ExplainabilityConfig *ExplainabilityConfig `type:"structure"` + // The state of the monitor's latest evaluation. + LastEvaluationState *string `type:"string"` - // The name of the Explainability. - ExplainabilityName *string `min:"1" type:"string"` + // The timestamp of the latest evaluation completed by the monitor. + LastEvaluationTime *time.Time `type:"timestamp"` - // 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. + // The timestamp of the latest modification to the monitor. LastModificationTime *time.Time `type:"timestamp"` - // Information about any errors that may have occurred during the Explainability - // creation process. + // An error message, if any, for the monitor. Message *string `type:"string"` - // The Amazon Resource Name (ARN) of the Predictor or Forecast used to create - // the Explainability. + // The Amazon Resource Name (ARN) of the monitor resource described. + MonitorArn *string `type:"string"` + + // The name of the monitor. + MonitorName *string `min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of the auto predictor being monitored. 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 + // The status of the monitor resource. Status *string `type:"string"` } @@ -12515,7 +13476,7 @@ type ExplainabilitySummary 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 ExplainabilitySummary) String() string { +func (s DescribeMonitorOutput) String() string { return awsutil.Prettify(s) } @@ -12524,94 +13485,83 @@ func (s ExplainabilitySummary) 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 ExplainabilitySummary) GoString() string { +func (s DescribeMonitorOutput) GoString() string { return s.String() } +// SetBaseline sets the Baseline field's value. +func (s *DescribeMonitorOutput) SetBaseline(v *Baseline) *DescribeMonitorOutput { + s.Baseline = v + return s +} + // SetCreationTime sets the CreationTime field's value. -func (s *ExplainabilitySummary) SetCreationTime(v time.Time) *ExplainabilitySummary { +func (s *DescribeMonitorOutput) SetCreationTime(v time.Time) *DescribeMonitorOutput { s.CreationTime = &v return s } -// SetExplainabilityArn sets the ExplainabilityArn field's value. -func (s *ExplainabilitySummary) SetExplainabilityArn(v string) *ExplainabilitySummary { - s.ExplainabilityArn = &v +// SetEstimatedEvaluationTimeRemainingInMinutes sets the EstimatedEvaluationTimeRemainingInMinutes field's value. +func (s *DescribeMonitorOutput) SetEstimatedEvaluationTimeRemainingInMinutes(v int64) *DescribeMonitorOutput { + s.EstimatedEvaluationTimeRemainingInMinutes = &v return s } -// SetExplainabilityConfig sets the ExplainabilityConfig field's value. -func (s *ExplainabilitySummary) SetExplainabilityConfig(v *ExplainabilityConfig) *ExplainabilitySummary { - s.ExplainabilityConfig = v +// SetLastEvaluationState sets the LastEvaluationState field's value. +func (s *DescribeMonitorOutput) SetLastEvaluationState(v string) *DescribeMonitorOutput { + s.LastEvaluationState = &v return s } -// SetExplainabilityName sets the ExplainabilityName field's value. -func (s *ExplainabilitySummary) SetExplainabilityName(v string) *ExplainabilitySummary { - s.ExplainabilityName = &v +// SetLastEvaluationTime sets the LastEvaluationTime field's value. +func (s *DescribeMonitorOutput) SetLastEvaluationTime(v time.Time) *DescribeMonitorOutput { + s.LastEvaluationTime = &v return s } // SetLastModificationTime sets the LastModificationTime field's value. -func (s *ExplainabilitySummary) SetLastModificationTime(v time.Time) *ExplainabilitySummary { +func (s *DescribeMonitorOutput) SetLastModificationTime(v time.Time) *DescribeMonitorOutput { s.LastModificationTime = &v return s } // SetMessage sets the Message field's value. -func (s *ExplainabilitySummary) SetMessage(v string) *ExplainabilitySummary { +func (s *DescribeMonitorOutput) SetMessage(v string) *DescribeMonitorOutput { s.Message = &v return s } +// SetMonitorArn sets the MonitorArn field's value. +func (s *DescribeMonitorOutput) SetMonitorArn(v string) *DescribeMonitorOutput { + s.MonitorArn = &v + return s +} + +// SetMonitorName sets the MonitorName field's value. +func (s *DescribeMonitorOutput) SetMonitorName(v string) *DescribeMonitorOutput { + s.MonitorName = &v + return s +} + // SetResourceArn sets the ResourceArn field's value. -func (s *ExplainabilitySummary) SetResourceArn(v string) *ExplainabilitySummary { +func (s *DescribeMonitorOutput) SetResourceArn(v string) *DescribeMonitorOutput { s.ResourceArn = &v return s } // SetStatus sets the Status field's value. -func (s *ExplainabilitySummary) SetStatus(v string) *ExplainabilitySummary { +func (s *DescribeMonitorOutput) SetStatus(v string) *DescribeMonitorOutput { s.Status = &v return s } -// This object belongs to the CreatePredictor operation. If you created your -// predictor with CreateAutoPredictor, see AttributeConfig. -// -// 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"} -// -// } ] -// -// } -type Featurization struct { +type DescribePredictorBacktestExportJobInput struct { _ struct{} `type:"structure"` - // 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. + // The Amazon Resource Name (ARN) of the predictor backtest export job. // - // AttributeName is a required field - AttributeName *string `min:"1" type:"string" required:"true"` - - // An array of one FeaturizationMethod object that specifies the feature transformation - // method. - FeaturizationPipeline []*FeaturizationMethod `min:"1" type:"list"` + // PredictorBacktestExportJobArn is a required field + PredictorBacktestExportJobArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -12619,7 +13569,7 @@ type Featurization 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 Featurization) String() string { +func (s DescribePredictorBacktestExportJobInput) String() string { return awsutil.Prettify(s) } @@ -12628,31 +13578,15 @@ func (s Featurization) 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 Featurization) GoString() string { +func (s DescribePredictorBacktestExportJobInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *Featurization) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "Featurization"} - if s.AttributeName == nil { - invalidParams.Add(request.NewErrParamRequired("AttributeName")) - } - if s.AttributeName != nil && len(*s.AttributeName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("AttributeName", 1)) - } - if s.FeaturizationPipeline != nil && len(s.FeaturizationPipeline) < 1 { - invalidParams.Add(request.NewErrParamMinLen("FeaturizationPipeline", 1)) - } - if s.FeaturizationPipeline != nil { - for i, v := range s.FeaturizationPipeline { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "FeaturizationPipeline", i), err.(request.ErrInvalidParams)) - } - } +func (s *DescribePredictorBacktestExportJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribePredictorBacktestExportJobInput"} + if s.PredictorBacktestExportJobArn == nil { + invalidParams.Add(request.NewErrParamRequired("PredictorBacktestExportJobArn")) } if invalidParams.Len() > 0 { @@ -12661,71 +13595,62 @@ func (s *Featurization) Validate() error { return nil } -// SetAttributeName sets the AttributeName field's value. -func (s *Featurization) SetAttributeName(v string) *Featurization { - s.AttributeName = &v - return s -} - -// SetFeaturizationPipeline sets the FeaturizationPipeline field's value. -func (s *Featurization) SetFeaturizationPipeline(v []*FeaturizationMethod) *Featurization { - s.FeaturizationPipeline = v +// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value. +func (s *DescribePredictorBacktestExportJobInput) SetPredictorBacktestExportJobArn(v string) *DescribePredictorBacktestExportJobInput { + s.PredictorBacktestExportJobArn = &v return s } -// This object belongs to the CreatePredictor operation. If you created your -// predictor with CreateAutoPredictor, see AttributeConfig. -// -// In a CreatePredictor operation, the specified algorithm trains a model using -// the specified dataset group. You can optionally tell the operation to modify -// data fields prior to training a model. These modifications are referred to -// as featurization. -// -// You define featurization using the FeaturizationConfig object. You specify -// an array of transformations, one for each field that you want to featurize. -// You then include the FeaturizationConfig object in your CreatePredictor request. -// Amazon Forecast applies the featurization to the TARGET_TIME_SERIES and RELATED_TIME_SERIES -// datasets before model training. -// -// You can create multiple featurization configurations. For example, you might -// call the CreatePredictor operation twice by specifying different featurization -// configurations. -type FeaturizationConfig struct { +type DescribePredictorBacktestExportJobOutput struct { _ struct{} `type:"structure"` - // An array of featurization (transformation) information for the fields of - // a dataset. - Featurizations []*Featurization `min:"1" type:"list"` + // When the predictor backtest export job was created. + CreationTime *time.Time `type:"timestamp"` - // An array of dimension (field) names that specify how to group the generated - // forecast. - // - // For example, suppose that you are generating a forecast for item sales across - // all of your stores, and your dataset contains a store_id field. If you want - // the sales forecast for each item by store, you would specify store_id as - // the dimension. - // - // All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't - // need to be specified in the CreatePredictor request. All forecast dimensions - // specified in the RELATED_TIME_SERIES dataset must be specified in the CreatePredictor - // request. - ForecastDimensions []*string `min:"1" type:"list"` + // 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 frequency of predictions in a forecast. + // The format of the exported data, CSV or PARQUET. + Format *string `type:"string"` + + // The last time the resource was modified. The timestamp depends on the status + // of the job: // - // 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. + // * CREATE_PENDING - The CreationTime. // - // The frequency must be greater than or equal to the TARGET_TIME_SERIES dataset - // frequency. + // * CREATE_IN_PROGRESS - The current timestamp. // - // When a RELATED_TIME_SERIES dataset is provided, the frequency must be equal - // to the RELATED_TIME_SERIES dataset frequency. + // * CREATE_STOPPING - The current timestamp. // - // ForecastFrequency is a required field - ForecastFrequency *string `min:"1" type:"string" required:"true"` + // * CREATE_STOPPED - When the job stopped. + // + // * ACTIVE or CREATE_FAILED - When the job finished or failed. + LastModificationTime *time.Time `type:"timestamp"` + + // Information about any errors that may have occurred during the backtest export. + Message *string `type:"string"` + + // The Amazon Resource Name (ARN) of the predictor. + PredictorArn *string `type:"string"` + + // The Amazon Resource Name (ARN) of the predictor backtest export job. + PredictorBacktestExportJobArn *string `type:"string"` + + // The name of the predictor backtest export job. + PredictorBacktestExportJobName *string `min:"1" type:"string"` + + // The status of the predictor backtest export job. 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. @@ -12733,7 +13658,7 @@ type FeaturizationConfig 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 FeaturizationConfig) String() string { +func (s DescribePredictorBacktestExportJobOutput) String() string { return awsutil.Prettify(s) } @@ -12742,112 +13667,72 @@ func (s FeaturizationConfig) 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 FeaturizationConfig) GoString() string { +func (s DescribePredictorBacktestExportJobOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *FeaturizationConfig) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "FeaturizationConfig"} - if s.Featurizations != nil && len(s.Featurizations) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Featurizations", 1)) - } - if s.ForecastDimensions != nil && len(s.ForecastDimensions) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ForecastDimensions", 1)) - } - 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 { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Featurizations", i), err.(request.ErrInvalidParams)) - } - } - } +// SetCreationTime sets the CreationTime field's value. +func (s *DescribePredictorBacktestExportJobOutput) SetCreationTime(v time.Time) *DescribePredictorBacktestExportJobOutput { + s.CreationTime = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetDestination sets the Destination field's value. +func (s *DescribePredictorBacktestExportJobOutput) SetDestination(v *DataDestination) *DescribePredictorBacktestExportJobOutput { + s.Destination = v + return s } -// SetFeaturizations sets the Featurizations field's value. -func (s *FeaturizationConfig) SetFeaturizations(v []*Featurization) *FeaturizationConfig { - s.Featurizations = v +// SetFormat sets the Format field's value. +func (s *DescribePredictorBacktestExportJobOutput) SetFormat(v string) *DescribePredictorBacktestExportJobOutput { + s.Format = &v return s } -// SetForecastDimensions sets the ForecastDimensions field's value. -func (s *FeaturizationConfig) SetForecastDimensions(v []*string) *FeaturizationConfig { - s.ForecastDimensions = v +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DescribePredictorBacktestExportJobOutput) SetLastModificationTime(v time.Time) *DescribePredictorBacktestExportJobOutput { + s.LastModificationTime = &v return s } -// SetForecastFrequency sets the ForecastFrequency field's value. -func (s *FeaturizationConfig) SetForecastFrequency(v string) *FeaturizationConfig { - s.ForecastFrequency = &v +// SetMessage sets the Message field's value. +func (s *DescribePredictorBacktestExportJobOutput) SetMessage(v string) *DescribePredictorBacktestExportJobOutput { + s.Message = &v return s } -// Provides information about the method that featurizes (transforms) a dataset -// field. The method is part of the FeaturizationPipeline of the Featurization -// object. -// -// The following is an example of how you specify a FeaturizationMethod object. -// -// { -// -// "FeaturizationMethodName": "filling", -// -// "FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", -// "backfill": "zero"} -// -// } -type FeaturizationMethod struct { - _ struct{} `type:"structure"` +// SetPredictorArn sets the PredictorArn field's value. +func (s *DescribePredictorBacktestExportJobOutput) SetPredictorArn(v string) *DescribePredictorBacktestExportJobOutput { + s.PredictorArn = &v + return s +} - // The name of the method. The "filling" method is the only supported method. - // - // FeaturizationMethodName is a required field - FeaturizationMethodName *string `type:"string" required:"true" enum:"FeaturizationMethodName"` +// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value. +func (s *DescribePredictorBacktestExportJobOutput) SetPredictorBacktestExportJobArn(v string) *DescribePredictorBacktestExportJobOutput { + s.PredictorBacktestExportJobArn = &v + return s +} - // 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. Bold signifies the - // default value. - // - // * aggregation: sum, avg, first, min, max - // - // * frontfill: none - // - // * middlefill: zero, nan (not a number), value, median, mean, min, max - // - // * backfill: zero, nan, value, median, mean, min, max - // - // The following list shows the parameters and their valid values for a Related - // Time Series featurization method (there are no defaults): - // - // * middlefill: zero, value, median, mean, min, max - // - // * backfill: zero, value, median, mean, min, max - // - // * futurefill: zero, value, median, mean, min, max +// SetPredictorBacktestExportJobName sets the PredictorBacktestExportJobName field's value. +func (s *DescribePredictorBacktestExportJobOutput) SetPredictorBacktestExportJobName(v string) *DescribePredictorBacktestExportJobOutput { + s.PredictorBacktestExportJobName = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *DescribePredictorBacktestExportJobOutput) SetStatus(v string) *DescribePredictorBacktestExportJobOutput { + s.Status = &v + return s +} + +type DescribePredictorInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the predictor that you want information + // about. // - // 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". - FeaturizationMethodParameters map[string]*string `min:"1" type:"map"` + // PredictorArn is a required field + PredictorArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -12855,7 +13740,7 @@ type FeaturizationMethod 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 FeaturizationMethod) String() string { +func (s DescribePredictorInput) String() string { return awsutil.Prettify(s) } @@ -12864,18 +13749,15 @@ func (s FeaturizationMethod) 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 FeaturizationMethod) GoString() string { +func (s DescribePredictorInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *FeaturizationMethod) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "FeaturizationMethod"} - if s.FeaturizationMethodName == nil { - invalidParams.Add(request.NewErrParamRequired("FeaturizationMethodName")) - } - if s.FeaturizationMethodParameters != nil && len(s.FeaturizationMethodParameters) < 1 { - invalidParams.Add(request.NewErrParamMinLen("FeaturizationMethodParameters", 1)) +func (s *DescribePredictorInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribePredictorInput"} + if s.PredictorArn == nil { + invalidParams.Add(request.NewErrParamRequired("PredictorArn")) } if invalidParams.Len() > 0 { @@ -12884,115 +13766,71 @@ func (s *FeaturizationMethod) Validate() error { return nil } -// SetFeaturizationMethodName sets the FeaturizationMethodName field's value. -func (s *FeaturizationMethod) SetFeaturizationMethodName(v string) *FeaturizationMethod { - s.FeaturizationMethodName = &v - return s -} - -// SetFeaturizationMethodParameters sets the FeaturizationMethodParameters field's value. -func (s *FeaturizationMethod) SetFeaturizationMethodParameters(v map[string]*string) *FeaturizationMethod { - s.FeaturizationMethodParameters = v +// SetPredictorArn sets the PredictorArn field's value. +func (s *DescribePredictorInput) SetPredictorArn(v string) *DescribePredictorInput { + s.PredictorArn = &v return s } -// Describes a filter for choosing a subset of objects. Each filter consists -// of a condition and a match statement. The condition is either IS or IS_NOT, -// which specifies whether to include or exclude the objects that match the -// statement, respectively. The match statement consists of a key and a value. -type Filter struct { +type DescribePredictorOutput struct { _ struct{} `type:"structure"` - // The condition to apply. To include the objects that match the statement, - // specify IS. To exclude matching objects, specify IS_NOT. - // - // Condition is a required field - Condition *string `type:"string" required:"true" enum:"FilterConditionString"` + // The Amazon Resource Name (ARN) of the algorithm used for model training. + AlgorithmArn *string `type:"string"` - // The name of the parameter to filter on. - // - // Key is a required field - Key *string `type:"string" required:"true"` + // When PerformAutoML is specified, the ARN of the chosen algorithm. + AutoMLAlgorithmArns []*string `type:"list"` - // The value to match. // - // Value is a required field - Value *string `type:"string" required:"true"` -} + // The LatencyOptimized AutoML override strategy is only available in private + // beta. Contact AWS Support or your account manager to learn more about access + // privileges. + // + // The AutoML strategy used to train the predictor. Unless LatencyOptimized + // is specified, the AutoML strategy optimizes predictor accuracy. + // + // This parameter is only valid for predictors trained using AutoML. + AutoMLOverrideStrategy *string `type:"string" enum:"AutoMLOverrideStrategy"` -// 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 Filter) 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 Filter) GoString() string { - return s.String() -} + // When the model training task was created. + CreationTime *time.Time `type:"timestamp"` -// Validate inspects the fields of the type to determine if they are valid. -func (s *Filter) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "Filter"} - if s.Condition == nil { - invalidParams.Add(request.NewErrParamRequired("Condition")) - } - if s.Key == nil { - invalidParams.Add(request.NewErrParamRequired("Key")) - } - if s.Value == nil { - invalidParams.Add(request.NewErrParamRequired("Value")) - } + // An array of the ARNs of the dataset import jobs used to import training data + // for the predictor. + DatasetImportJobArns []*string `type:"list"` - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} + // 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"` -// SetCondition sets the Condition field's value. -func (s *Filter) SetCondition(v string) *Filter { - s.Condition = &v - return s -} + // The estimated time remaining in minutes for the predictor training job to + // complete. + EstimatedTimeRemainingInMinutes *int64 `type:"long"` -// SetKey sets the Key field's value. -func (s *Filter) SetKey(v string) *Filter { - s.Key = &v - return s -} + // 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"` -// SetValue sets the Value field's value. -func (s *Filter) SetValue(v string) *Filter { - s.Value = &v - return s -} + // The featurization configuration. + FeaturizationConfig *FeaturizationConfig `type:"structure"` -// Provides a summary of the forecast export job properties used in the ListForecastExportJobs -// operation. To get the complete set of properties, call the DescribeForecastExportJob -// operation, and provide the listed ForecastExportJobArn. -type ForecastExportJobSummary struct { - _ struct{} `type:"structure"` + // The number of time-steps of the forecast. The forecast horizon is also called + // the prediction length. + ForecastHorizon *int64 `type:"integer"` - // When the forecast export job was created. - CreationTime *time.Time `type:"timestamp"` + // The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"] + ForecastTypes []*string `min:"1" type:"list"` - // The path to the Amazon Simple Storage Service (Amazon S3) bucket where the - // forecast is exported. - Destination *DataDestination `type:"structure"` + // The hyperparameter override values for the algorithm. + HPOConfig *HyperParameterTuningJobConfig `type:"structure"` - // The Amazon Resource Name (ARN) of the forecast export job. - ForecastExportJobArn *string `type:"string"` + // Describes the dataset group that contains the data to use to train the predictor. + InputDataConfig *InputDataConfig `type:"structure"` - // The name of the forecast export job. - ForecastExportJobName *string `min:"1" type:"string"` + // 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: @@ -13011,19 +13849,45 @@ type ForecastExportJobSummary struct { // If an error occurred, an informational message about the error. Message *string `type:"string"` - // The status of the forecast export job. States include: + // The accuracy metric used to optimize the predictor. + OptimizationMetric *string `type:"string" enum:"OptimizationMetric"` + + // Whether the predictor is set to perform AutoML. + PerformAutoML *bool `type:"boolean"` + + // Whether the predictor is set to perform hyperparameter optimization (HPO). + PerformHPO *bool `type:"boolean"` + + // The ARN of the predictor. + PredictorArn *string `min:"1" type:"string"` + + // Details on the the status and results of the backtests performed to evaluate + // the accuracy of the predictor. You specify the number of backtests to perform + // when you call the operation. + PredictorExecutionDetails *PredictorExecutionDetails `type:"structure"` + + // The name of the predictor. + PredictorName *string `min:"1" type:"string"` + + // 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 // - // The Status of the forecast export job must be ACTIVE before you can access - // the forecast in your S3 bucket. + // * CREATE_STOPPING, CREATE_STOPPED + // + // The Status of the predictor must be ACTIVE before you can use the predictor + // 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"` } // String returns the string representation. @@ -13031,7 +13895,7 @@ type ForecastExportJobSummary 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 ForecastExportJobSummary) String() string { +func (s DescribePredictorOutput) String() string { return awsutil.Prettify(s) } @@ -13040,95 +13904,231 @@ func (s ForecastExportJobSummary) 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 ForecastExportJobSummary) GoString() string { +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 *ForecastExportJobSummary) SetCreationTime(v time.Time) *ForecastExportJobSummary { +func (s *DescribePredictorOutput) SetCreationTime(v time.Time) *DescribePredictorOutput { s.CreationTime = &v return s } -// SetDestination sets the Destination field's value. -func (s *ForecastExportJobSummary) SetDestination(v *DataDestination) *ForecastExportJobSummary { - s.Destination = v +// SetDatasetImportJobArns sets the DatasetImportJobArns field's value. +func (s *DescribePredictorOutput) SetDatasetImportJobArns(v []*string) *DescribePredictorOutput { + s.DatasetImportJobArns = v return s } -// SetForecastExportJobArn sets the ForecastExportJobArn field's value. -func (s *ForecastExportJobSummary) SetForecastExportJobArn(v string) *ForecastExportJobSummary { - s.ForecastExportJobArn = &v +// SetEncryptionConfig sets the EncryptionConfig field's value. +func (s *DescribePredictorOutput) SetEncryptionConfig(v *EncryptionConfig) *DescribePredictorOutput { + s.EncryptionConfig = v return s } -// SetForecastExportJobName sets the ForecastExportJobName field's value. -func (s *ForecastExportJobSummary) SetForecastExportJobName(v string) *ForecastExportJobSummary { - s.ForecastExportJobName = &v +// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value. +func (s *DescribePredictorOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribePredictorOutput { + s.EstimatedTimeRemainingInMinutes = &v return s } -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *ForecastExportJobSummary) SetLastModificationTime(v time.Time) *ForecastExportJobSummary { - s.LastModificationTime = &v +// SetEvaluationParameters sets the EvaluationParameters field's value. +func (s *DescribePredictorOutput) SetEvaluationParameters(v *EvaluationParameters) *DescribePredictorOutput { + s.EvaluationParameters = v return s } -// SetMessage sets the Message field's value. -func (s *ForecastExportJobSummary) SetMessage(v string) *ForecastExportJobSummary { - s.Message = &v +// SetFeaturizationConfig sets the FeaturizationConfig field's value. +func (s *DescribePredictorOutput) SetFeaturizationConfig(v *FeaturizationConfig) *DescribePredictorOutput { + s.FeaturizationConfig = v return s } -// SetStatus sets the Status field's value. -func (s *ForecastExportJobSummary) SetStatus(v string) *ForecastExportJobSummary { - s.Status = &v +// SetForecastHorizon sets the ForecastHorizon field's value. +func (s *DescribePredictorOutput) SetForecastHorizon(v int64) *DescribePredictorOutput { + s.ForecastHorizon = &v return s } -// Provides a summary of the forecast properties used in the ListForecasts operation. -// To get the complete set of properties, call the DescribeForecast operation, -// and provide the ForecastArn that is listed in the summary. -type ForecastSummary struct { - _ struct{} `type:"structure"` +// SetForecastTypes sets the ForecastTypes field's value. +func (s *DescribePredictorOutput) SetForecastTypes(v []*string) *DescribePredictorOutput { + s.ForecastTypes = v + return s +} - // Whether the Forecast was created from an AutoPredictor. - CreatedUsingAutoPredictor *bool `type:"boolean"` +// SetHPOConfig sets the HPOConfig field's value. +func (s *DescribePredictorOutput) SetHPOConfig(v *HyperParameterTuningJobConfig) *DescribePredictorOutput { + s.HPOConfig = v + return s +} - // When the forecast creation task was created. - CreationTime *time.Time `type:"timestamp"` +// SetInputDataConfig sets the InputDataConfig field's value. +func (s *DescribePredictorOutput) SetInputDataConfig(v *InputDataConfig) *DescribePredictorOutput { + s.InputDataConfig = v + return s +} - // The Amazon Resource Name (ARN) of the dataset group that provided the data - // used to train the predictor. - DatasetGroupArn *string `type:"string"` +// SetIsAutoPredictor sets the IsAutoPredictor field's value. +func (s *DescribePredictorOutput) SetIsAutoPredictor(v bool) *DescribePredictorOutput { + s.IsAutoPredictor = &v + return s +} - // The ARN of the forecast. - ForecastArn *string `type:"string"` +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DescribePredictorOutput) SetLastModificationTime(v time.Time) *DescribePredictorOutput { + s.LastModificationTime = &v + return s +} - // The name of the forecast. - ForecastName *string `min:"1" type:"string"` +// SetMessage sets the Message field's value. +func (s *DescribePredictorOutput) SetMessage(v string) *DescribePredictorOutput { + s.Message = &v + return s +} - // 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"` +// SetOptimizationMetric sets the OptimizationMetric field's value. +func (s *DescribePredictorOutput) SetOptimizationMetric(v string) *DescribePredictorOutput { + s.OptimizationMetric = &v + return s +} - // If an error occurred, an informational message about the error. - Message *string `type:"string"` +// SetPerformAutoML sets the PerformAutoML field's value. +func (s *DescribePredictorOutput) SetPerformAutoML(v bool) *DescribePredictorOutput { + s.PerformAutoML = &v + return s +} - // The ARN of the predictor used to generate the forecast. - PredictorArn *string `type:"string"` +// SetPerformHPO sets the PerformHPO field's value. +func (s *DescribePredictorOutput) SetPerformHPO(v bool) *DescribePredictorOutput { + s.PerformHPO = &v + return s +} - // The status of the forecast. States include: +// 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 +} + +type DescribeWhatIfAnalysisInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the what-if analysis that you are interested + // in. + // + // WhatIfAnalysisArn is a required field + WhatIfAnalysisArn *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 DescribeWhatIfAnalysisInput) 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 DescribeWhatIfAnalysisInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeWhatIfAnalysisInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeWhatIfAnalysisInput"} + if s.WhatIfAnalysisArn == nil { + invalidParams.Add(request.NewErrParamRequired("WhatIfAnalysisArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value. +func (s *DescribeWhatIfAnalysisInput) SetWhatIfAnalysisArn(v string) *DescribeWhatIfAnalysisInput { + s.WhatIfAnalysisArn = &v + return s +} + +type DescribeWhatIfAnalysisOutput struct { + _ struct{} `type:"structure"` + + // When the what-if analysis was created. + CreationTime *time.Time `type:"timestamp"` + + // The approximate time remaining to complete the what-if analysis, in minutes. + EstimatedTimeRemainingInMinutes *int64 `type:"long"` + + // The Amazon Resource Name (ARN) of the what-if forecast. + ForecastArn *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 what-if analysis. States include: // // * ACTIVE // @@ -13138,9 +14138,27 @@ type ForecastSummary struct { // // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED // - // The Status of the forecast must be ACTIVE before you can query or export - // the forecast. + // The Status of the what-if analysis must be ACTIVE before you can access the + // analysis. Status *string `type:"string"` + + // Defines the set of time series that are used to create the forecasts in a + // TimeSeriesIdentifiers object. + // + // The TimeSeriesIdentifiers object needs the following information: + // + // * DataSource + // + // * Format + // + // * Schema + TimeSeriesSelector *TimeSeriesSelector `type:"structure"` + + // The Amazon Resource Name (ARN) of the what-if analysis. + WhatIfAnalysisArn *string `type:"string"` + + // The name of the what-if analysis. + WhatIfAnalysisName *string `min:"1" type:"string"` } // String returns the string representation. @@ -13148,7 +14166,7 @@ type ForecastSummary 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 ForecastSummary) String() string { +func (s DescribeWhatIfAnalysisOutput) String() string { return awsutil.Prettify(s) } @@ -13157,71 +14175,72 @@ func (s ForecastSummary) 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 ForecastSummary) GoString() string { +func (s DescribeWhatIfAnalysisOutput) 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 { +func (s *DescribeWhatIfAnalysisOutput) SetCreationTime(v time.Time) *DescribeWhatIfAnalysisOutput { s.CreationTime = &v return s } -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *ForecastSummary) SetDatasetGroupArn(v string) *ForecastSummary { - s.DatasetGroupArn = &v +// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value. +func (s *DescribeWhatIfAnalysisOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeWhatIfAnalysisOutput { + s.EstimatedTimeRemainingInMinutes = &v return s } // SetForecastArn sets the ForecastArn field's value. -func (s *ForecastSummary) SetForecastArn(v string) *ForecastSummary { +func (s *DescribeWhatIfAnalysisOutput) SetForecastArn(v string) *DescribeWhatIfAnalysisOutput { s.ForecastArn = &v return s } -// SetForecastName sets the ForecastName field's value. -func (s *ForecastSummary) SetForecastName(v string) *ForecastSummary { - s.ForecastName = &v - return s -} - // SetLastModificationTime sets the LastModificationTime field's value. -func (s *ForecastSummary) SetLastModificationTime(v time.Time) *ForecastSummary { +func (s *DescribeWhatIfAnalysisOutput) SetLastModificationTime(v time.Time) *DescribeWhatIfAnalysisOutput { s.LastModificationTime = &v return s } // SetMessage sets the Message field's value. -func (s *ForecastSummary) SetMessage(v string) *ForecastSummary { +func (s *DescribeWhatIfAnalysisOutput) SetMessage(v string) *DescribeWhatIfAnalysisOutput { s.Message = &v return s } -// SetPredictorArn sets the PredictorArn field's value. -func (s *ForecastSummary) SetPredictorArn(v string) *ForecastSummary { - s.PredictorArn = &v +// SetStatus sets the Status field's value. +func (s *DescribeWhatIfAnalysisOutput) SetStatus(v string) *DescribeWhatIfAnalysisOutput { + s.Status = &v return s } -// SetStatus sets the Status field's value. -func (s *ForecastSummary) SetStatus(v string) *ForecastSummary { - s.Status = &v +// SetTimeSeriesSelector sets the TimeSeriesSelector field's value. +func (s *DescribeWhatIfAnalysisOutput) SetTimeSeriesSelector(v *TimeSeriesSelector) *DescribeWhatIfAnalysisOutput { + s.TimeSeriesSelector = v return s } -type GetAccuracyMetricsInput struct { +// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value. +func (s *DescribeWhatIfAnalysisOutput) SetWhatIfAnalysisArn(v string) *DescribeWhatIfAnalysisOutput { + s.WhatIfAnalysisArn = &v + return s +} + +// SetWhatIfAnalysisName sets the WhatIfAnalysisName field's value. +func (s *DescribeWhatIfAnalysisOutput) SetWhatIfAnalysisName(v string) *DescribeWhatIfAnalysisOutput { + s.WhatIfAnalysisName = &v + return s +} + +type DescribeWhatIfForecastExportInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the predictor to get metrics for. + // The Amazon Resource Name (ARN) of the what-if forecast export that you are + // interested in. // - // PredictorArn is a required field - PredictorArn *string `type:"string" required:"true"` + // WhatIfForecastExportArn is a required field + WhatIfForecastExportArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -13229,7 +14248,7 @@ type GetAccuracyMetricsInput 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 GetAccuracyMetricsInput) String() string { +func (s DescribeWhatIfForecastExportInput) String() string { return awsutil.Prettify(s) } @@ -13238,15 +14257,15 @@ func (s GetAccuracyMetricsInput) 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 GetAccuracyMetricsInput) GoString() string { +func (s DescribeWhatIfForecastExportInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *GetAccuracyMetricsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "GetAccuracyMetricsInput"} - if s.PredictorArn == nil { - invalidParams.Add(request.NewErrParamRequired("PredictorArn")) +func (s *DescribeWhatIfForecastExportInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeWhatIfForecastExportInput"} + if s.WhatIfForecastExportArn == nil { + invalidParams.Add(request.NewErrParamRequired("WhatIfForecastExportArn")) } if invalidParams.Len() > 0 { @@ -13255,34 +14274,70 @@ func (s *GetAccuracyMetricsInput) Validate() error { return nil } -// SetPredictorArn sets the PredictorArn field's value. -func (s *GetAccuracyMetricsInput) SetPredictorArn(v string) *GetAccuracyMetricsInput { - s.PredictorArn = &v +// SetWhatIfForecastExportArn sets the WhatIfForecastExportArn field's value. +func (s *DescribeWhatIfForecastExportInput) SetWhatIfForecastExportArn(v string) *DescribeWhatIfForecastExportInput { + s.WhatIfForecastExportArn = &v return s } -type GetAccuracyMetricsOutput struct { +type DescribeWhatIfForecastExportOutput struct { _ struct{} `type:"structure"` + // When the what-if forecast export 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 approximate time remaining to complete the what-if forecast export, in + // minutes. + EstimatedTimeRemainingInMinutes *int64 `type:"long"` + + // The format of the exported data, CSV or PARQUET. + Format *string `type:"string"` + + // The last time the resource was modified. The timestamp depends on the status + // of the job: // - // The LatencyOptimized AutoML override strategy is only available in private - // beta. Contact AWS Support or your account manager to learn more about access - // privileges. + // * CREATE_PENDING - The CreationTime. // - // The AutoML strategy used to train the predictor. Unless LatencyOptimized - // is specified, the AutoML strategy optimizes predictor accuracy. + // * CREATE_IN_PROGRESS - The current timestamp. // - // This parameter is only valid for predictors trained using AutoML. - AutoMLOverrideStrategy *string `type:"string" enum:"AutoMLOverrideStrategy"` + // * 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"` - // Whether the predictor was created with CreateAutoPredictor. - IsAutoPredictor *bool `type:"boolean"` + // If an error occurred, an informational message about the error. + Message *string `type:"string"` - // The accuracy metric used to optimize the predictor. - OptimizationMetric *string `type:"string" enum:"OptimizationMetric"` + // The status of the what-if forecast. States include: + // + // * ACTIVE + // + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * CREATE_STOPPING, CREATE_STOPPED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // + // The Status of the what-if forecast export must be ACTIVE before you can access + // the forecast export. + Status *string `type:"string"` - // An array of results from evaluating the predictor. - PredictorEvaluationResults []*EvaluationResult `type:"list"` + // An array of Amazon Resource Names (ARNs) that represent all of the what-if + // forecasts exported in this resource. + WhatIfForecastArns []*string `type:"list"` + + // The Amazon Resource Name (ARN) of the what-if forecast export. + WhatIfForecastExportArn *string `type:"string"` + + // The name of the what-if forecast export. + WhatIfForecastExportName *string `min:"1" type:"string"` } // String returns the string representation. @@ -13290,7 +14345,7 @@ type GetAccuracyMetricsOutput 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 GetAccuracyMetricsOutput) String() string { +func (s DescribeWhatIfForecastExportOutput) String() string { return awsutil.Prettify(s) } @@ -13299,110 +14354,78 @@ func (s GetAccuracyMetricsOutput) 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 GetAccuracyMetricsOutput) GoString() string { +func (s DescribeWhatIfForecastExportOutput) GoString() string { return s.String() } -// SetAutoMLOverrideStrategy sets the AutoMLOverrideStrategy field's value. -func (s *GetAccuracyMetricsOutput) SetAutoMLOverrideStrategy(v string) *GetAccuracyMetricsOutput { - s.AutoMLOverrideStrategy = &v +// SetCreationTime sets the CreationTime field's value. +func (s *DescribeWhatIfForecastExportOutput) SetCreationTime(v time.Time) *DescribeWhatIfForecastExportOutput { + s.CreationTime = &v return s } -// SetIsAutoPredictor sets the IsAutoPredictor field's value. -func (s *GetAccuracyMetricsOutput) SetIsAutoPredictor(v bool) *GetAccuracyMetricsOutput { - s.IsAutoPredictor = &v +// SetDestination sets the Destination field's value. +func (s *DescribeWhatIfForecastExportOutput) SetDestination(v *DataDestination) *DescribeWhatIfForecastExportOutput { + s.Destination = v return s } -// SetOptimizationMetric sets the OptimizationMetric field's value. -func (s *GetAccuracyMetricsOutput) SetOptimizationMetric(v string) *GetAccuracyMetricsOutput { - s.OptimizationMetric = &v +// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value. +func (s *DescribeWhatIfForecastExportOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeWhatIfForecastExportOutput { + s.EstimatedTimeRemainingInMinutes = &v return s } -// SetPredictorEvaluationResults sets the PredictorEvaluationResults field's value. -func (s *GetAccuracyMetricsOutput) SetPredictorEvaluationResults(v []*EvaluationResult) *GetAccuracyMetricsOutput { - s.PredictorEvaluationResults = v +// SetFormat sets the Format field's value. +func (s *DescribeWhatIfForecastExportOutput) SetFormat(v string) *DescribeWhatIfForecastExportOutput { + s.Format = &v return s } -// Configuration information for a hyperparameter tuning job. You specify this -// object in the CreatePredictor request. -// -// A hyperparameter is a parameter that governs the model training process. -// You set hyperparameters before training starts, unlike model parameters, -// which are determined during training. The values of the hyperparameters effect -// which values are chosen for the model parameters. -// -// In a hyperparameter tuning job, Amazon Forecast chooses the set of hyperparameter -// values that optimize a specified metric. Forecast accomplishes this by running -// many training jobs over a range of hyperparameter values. The optimum set -// of values depends on the algorithm, the training data, and the specified -// metric objective. -type HyperParameterTuningJobConfig struct { - _ struct{} `type:"structure"` - - // Specifies the ranges of valid values for the hyperparameters. - ParameterRanges *ParameterRanges `type:"structure"` +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DescribeWhatIfForecastExportOutput) SetLastModificationTime(v time.Time) *DescribeWhatIfForecastExportOutput { + 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 HyperParameterTuningJobConfig) String() string { - return awsutil.Prettify(s) +// SetMessage sets the Message field's value. +func (s *DescribeWhatIfForecastExportOutput) SetMessage(v string) *DescribeWhatIfForecastExportOutput { + 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 HyperParameterTuningJobConfig) GoString() string { - return s.String() +// SetStatus sets the Status field's value. +func (s *DescribeWhatIfForecastExportOutput) SetStatus(v string) *DescribeWhatIfForecastExportOutput { + s.Status = &v + return s } -// Validate inspects the fields of the type to determine if they are valid. -func (s *HyperParameterTuningJobConfig) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "HyperParameterTuningJobConfig"} - if s.ParameterRanges != nil { - if err := s.ParameterRanges.Validate(); err != nil { - invalidParams.AddNested("ParameterRanges", err.(request.ErrInvalidParams)) - } - } +// SetWhatIfForecastArns sets the WhatIfForecastArns field's value. +func (s *DescribeWhatIfForecastExportOutput) SetWhatIfForecastArns(v []*string) *DescribeWhatIfForecastExportOutput { + s.WhatIfForecastArns = v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetWhatIfForecastExportArn sets the WhatIfForecastExportArn field's value. +func (s *DescribeWhatIfForecastExportOutput) SetWhatIfForecastExportArn(v string) *DescribeWhatIfForecastExportOutput { + s.WhatIfForecastExportArn = &v + return s } -// SetParameterRanges sets the ParameterRanges field's value. -func (s *HyperParameterTuningJobConfig) SetParameterRanges(v *ParameterRanges) *HyperParameterTuningJobConfig { - s.ParameterRanges = v +// SetWhatIfForecastExportName sets the WhatIfForecastExportName field's value. +func (s *DescribeWhatIfForecastExportOutput) SetWhatIfForecastExportName(v string) *DescribeWhatIfForecastExportOutput { + s.WhatIfForecastExportName = &v return s } -// This object belongs to the CreatePredictor operation. If you created your -// predictor with CreateAutoPredictor, see DataConfig. -// -// The data used to train a predictor. The data includes a dataset group and -// any supplementary features. You specify this object in the CreatePredictor -// request. -type InputDataConfig struct { +type DescribeWhatIfForecastInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset group. + // The Amazon Resource Name (ARN) of the what-if forecast that you are interested + // in. // - // DatasetGroupArn is a required field - DatasetGroupArn *string `type:"string" required:"true"` - - // An array of supplementary features. The only supported feature is a holiday - // calendar. - SupplementaryFeatures []*SupplementaryFeature `min:"1" type:"list"` + // WhatIfForecastArn is a required field + WhatIfForecastArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -13410,7 +14433,7 @@ type InputDataConfig 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 InputDataConfig) String() string { +func (s DescribeWhatIfForecastInput) String() string { return awsutil.Prettify(s) } @@ -13419,28 +14442,15 @@ func (s InputDataConfig) 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 InputDataConfig) GoString() string { +func (s DescribeWhatIfForecastInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *InputDataConfig) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "InputDataConfig"} - if s.DatasetGroupArn == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn")) - } - if s.SupplementaryFeatures != nil && len(s.SupplementaryFeatures) < 1 { - invalidParams.Add(request.NewErrParamMinLen("SupplementaryFeatures", 1)) - } - if s.SupplementaryFeatures != nil { - for i, v := range s.SupplementaryFeatures { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "SupplementaryFeatures", i), err.(request.ErrInvalidParams)) - } - } +func (s *DescribeWhatIfForecastInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeWhatIfForecastInput"} + if s.WhatIfForecastArn == nil { + invalidParams.Add(request.NewErrParamRequired("WhatIfForecastArn")) } if invalidParams.Len() > 0 { @@ -13449,68 +14459,74 @@ func (s *InputDataConfig) Validate() error { return nil } -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *InputDataConfig) SetDatasetGroupArn(v string) *InputDataConfig { - s.DatasetGroupArn = &v - return s -} - -// SetSupplementaryFeatures sets the SupplementaryFeatures field's value. -func (s *InputDataConfig) SetSupplementaryFeatures(v []*SupplementaryFeature) *InputDataConfig { - s.SupplementaryFeatures = v +// SetWhatIfForecastArn sets the WhatIfForecastArn field's value. +func (s *DescribeWhatIfForecastInput) SetWhatIfForecastArn(v string) *DescribeWhatIfForecastInput { + s.WhatIfForecastArn = &v return s } -// Specifies an integer hyperparameter and it's range of tunable values. This -// object is part of the ParameterRanges object. -type IntegerParameterRange struct { +type DescribeWhatIfForecastOutput struct { _ struct{} `type:"structure"` - // The maximum tunable value of the hyperparameter. - // - // MaxValue is a required field - MaxValue *int64 `type:"integer" required:"true"` + // When the what-if forecast was created. + CreationTime *time.Time `type:"timestamp"` - // The minimum tunable value of the hyperparameter. - // - // MinValue is a required field - MinValue *int64 `type:"integer" required:"true"` + // The approximate time remaining to complete the what-if forecast, in minutes. + EstimatedTimeRemainingInMinutes *int64 `type:"long"` - // The name of the hyperparameter to tune. - // - // Name is a required field - Name *string `min:"1" type:"string" required:"true"` + // The quantiles at which probabilistic forecasts are generated. You can specify + // up to 5 quantiles per what-if forecast in the CreateWhatIfForecast operation. + // If you didn't specify quantiles, the default values are ["0.1", "0.5", "0.9"]. + ForecastTypes []*string `min:"1" type:"list"` - // The scale that hyperparameter tuning uses to search the hyperparameter range. - // Valid values: - // - // Auto + // The last time the resource was modified. The timestamp depends on the status + // of the job: // - // Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter. + // * CREATE_PENDING - The CreationTime. // - // Linear + // * CREATE_IN_PROGRESS - The current timestamp. // - // Hyperparameter tuning searches the values in the hyperparameter range by - // using a linear scale. + // * CREATE_STOPPING - The current timestamp. // - // Logarithmic + // * CREATE_STOPPED - When the job stopped. // - // Hyperparameter tuning searches the values in the hyperparameter range by - // using a logarithmic scale. + // * 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 what-if forecast. States include: // - // Logarithmic scaling works only for ranges that have values greater than 0. + // * ACTIVE // - // ReverseLogarithmic + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED // - // Not supported for IntegerParameterRange. + // * CREATE_STOPPING, CREATE_STOPPED // - // Reverse logarithmic scaling works only for ranges that are entirely within - // the range 0 <= x < 1.0. + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED // - // 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"` + // The Status of the what-if forecast must be ACTIVE before you can access the + // forecast. + Status *string `type:"string"` + + // An array of S3Config, Schema, and Format elements that describe the replacement + // time series. + TimeSeriesReplacementsDataSource *TimeSeriesReplacementsDataSource `type:"structure"` + + // An array of Action and TimeSeriesConditions elements that describe what transformations + // were applied to which time series. + TimeSeriesTransformations []*TimeSeriesTransformation `type:"list"` + + // The Amazon Resource Name (ARN) of the what-if analysis that contains this + // forecast. + WhatIfAnalysisArn *string `type:"string"` + + // The Amazon Resource Name (ARN) of the what-if forecast. + WhatIfForecastArn *string `type:"string"` + + // The name of the what-if forecast. + WhatIfForecastName *string `min:"1" type:"string"` } // String returns the string representation. @@ -13518,7 +14534,7 @@ type IntegerParameterRange 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 IntegerParameterRange) String() string { +func (s DescribeWhatIfForecastOutput) String() string { return awsutil.Prettify(s) } @@ -13527,63 +14543,95 @@ func (s IntegerParameterRange) 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 IntegerParameterRange) GoString() string { +func (s DescribeWhatIfForecastOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *IntegerParameterRange) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "IntegerParameterRange"} - if s.MaxValue == nil { - invalidParams.Add(request.NewErrParamRequired("MaxValue")) - } - if s.MinValue == nil { - invalidParams.Add(request.NewErrParamRequired("MinValue")) - } - if s.Name == nil { - invalidParams.Add(request.NewErrParamRequired("Name")) - } - if s.Name != nil && len(*s.Name) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Name", 1)) - } +// SetCreationTime sets the CreationTime field's value. +func (s *DescribeWhatIfForecastOutput) SetCreationTime(v time.Time) *DescribeWhatIfForecastOutput { + s.CreationTime = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetEstimatedTimeRemainingInMinutes sets the EstimatedTimeRemainingInMinutes field's value. +func (s *DescribeWhatIfForecastOutput) SetEstimatedTimeRemainingInMinutes(v int64) *DescribeWhatIfForecastOutput { + s.EstimatedTimeRemainingInMinutes = &v + return s } -// SetMaxValue sets the MaxValue field's value. -func (s *IntegerParameterRange) SetMaxValue(v int64) *IntegerParameterRange { - s.MaxValue = &v +// SetForecastTypes sets the ForecastTypes field's value. +func (s *DescribeWhatIfForecastOutput) SetForecastTypes(v []*string) *DescribeWhatIfForecastOutput { + s.ForecastTypes = v return s } -// SetMinValue sets the MinValue field's value. -func (s *IntegerParameterRange) SetMinValue(v int64) *IntegerParameterRange { - s.MinValue = &v +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *DescribeWhatIfForecastOutput) SetLastModificationTime(v time.Time) *DescribeWhatIfForecastOutput { + s.LastModificationTime = &v return s } -// SetName sets the Name field's value. -func (s *IntegerParameterRange) SetName(v string) *IntegerParameterRange { - s.Name = &v +// SetMessage sets the Message field's value. +func (s *DescribeWhatIfForecastOutput) SetMessage(v string) *DescribeWhatIfForecastOutput { + s.Message = &v return s } -// SetScalingType sets the ScalingType field's value. -func (s *IntegerParameterRange) SetScalingType(v string) *IntegerParameterRange { - s.ScalingType = &v +// SetStatus sets the Status field's value. +func (s *DescribeWhatIfForecastOutput) SetStatus(v string) *DescribeWhatIfForecastOutput { + s.Status = &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:"-"` +// SetTimeSeriesReplacementsDataSource sets the TimeSeriesReplacementsDataSource field's value. +func (s *DescribeWhatIfForecastOutput) SetTimeSeriesReplacementsDataSource(v *TimeSeriesReplacementsDataSource) *DescribeWhatIfForecastOutput { + s.TimeSeriesReplacementsDataSource = v + return s +} - Message_ *string `locationName:"Message" type:"string"` +// SetTimeSeriesTransformations sets the TimeSeriesTransformations field's value. +func (s *DescribeWhatIfForecastOutput) SetTimeSeriesTransformations(v []*TimeSeriesTransformation) *DescribeWhatIfForecastOutput { + s.TimeSeriesTransformations = v + return s +} + +// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value. +func (s *DescribeWhatIfForecastOutput) SetWhatIfAnalysisArn(v string) *DescribeWhatIfForecastOutput { + s.WhatIfAnalysisArn = &v + return s +} + +// SetWhatIfForecastArn sets the WhatIfForecastArn field's value. +func (s *DescribeWhatIfForecastOutput) SetWhatIfForecastArn(v string) *DescribeWhatIfForecastOutput { + s.WhatIfForecastArn = &v + return s +} + +// SetWhatIfForecastName sets the WhatIfForecastName field's value. +func (s *DescribeWhatIfForecastOutput) SetWhatIfForecastName(v string) *DescribeWhatIfForecastOutput { + s.WhatIfForecastName = &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. @@ -13591,7 +14639,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 EncryptionConfig) String() string { return awsutil.Prettify(s) } @@ -13600,54 +14648,57 @@ 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 EncryptionConfig) GoString() string { return s.String() } -func newErrorInvalidInputException(v protocol.ResponseMetadata) error { - return &InvalidInputException{ - RespMetadata: v, +// 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")) } -} -// Code returns the exception type name. -func (s *InvalidInputException) Code() string { - return "InvalidInputException" + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// Message returns the exception's message. -func (s *InvalidInputException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" +// SetKMSKeyArn sets the KMSKeyArn field's value. +func (s *EncryptionConfig) SetKMSKeyArn(v string) *EncryptionConfig { + s.KMSKeyArn = &v + return s } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *InvalidInputException) OrigErr() error { - return nil +// SetRoleArn sets the RoleArn field's value. +func (s *EncryptionConfig) SetRoleArn(v string) *EncryptionConfig { + s.RoleArn = &v + return s } -func (s *InvalidInputException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) -} +// 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"` -// Status code returns the HTTP status code for the request's response error. -func (s *InvalidInputException) StatusCode() int { - return s.RespMetadata.StatusCode -} + // The Forecast type used to compute WAPE, MAPE, MASE, and RMSE. + ForecastType *string `min:"2" type:"string"` -// RequestID returns the service's response RequestID for request. -func (s *InvalidInputException) RequestID() string { - return s.RespMetadata.RequestID -} + // The Mean Absolute Percentage Error (MAPE) + MAPE *float64 `type:"double"` -// The token is not valid. Tokens expire after 24 hours. -type InvalidNextTokenException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + // The Mean Absolute Scaled Error (MASE) + MASE *float64 `type:"double"` - Message_ *string `locationName:"Message" type:"string"` + // 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. @@ -13655,7 +14706,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 ErrorMetric) String() string { return awsutil.Prettify(s) } @@ -13664,54 +14715,61 @@ 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 ErrorMetric) GoString() string { return s.String() } -func newErrorInvalidNextTokenException(v protocol.ResponseMetadata) error { - return &InvalidNextTokenException{ - RespMetadata: v, - } -} - -// Code returns the exception type name. -func (s *InvalidNextTokenException) Code() string { - return "InvalidNextTokenException" +// SetForecastType sets the ForecastType field's value. +func (s *ErrorMetric) SetForecastType(v string) *ErrorMetric { + s.ForecastType = &v + return s } -// Message returns the exception's message. -func (s *InvalidNextTokenException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" +// SetMAPE sets the MAPE field's value. +func (s *ErrorMetric) SetMAPE(v float64) *ErrorMetric { + s.MAPE = &v + return s } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *InvalidNextTokenException) OrigErr() error { - return nil +// SetMASE sets the MASE field's value. +func (s *ErrorMetric) SetMASE(v float64) *ErrorMetric { + s.MASE = &v + return s } -func (s *InvalidNextTokenException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// SetRMSE sets the RMSE field's value. +func (s *ErrorMetric) SetRMSE(v float64) *ErrorMetric { + s.RMSE = &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 +// SetWAPE sets the WAPE field's value. +func (s *ErrorMetric) SetWAPE(v float64) *ErrorMetric { + s.WAPE = &v + return s } -// RequestID returns the service's response RequestID for request. -func (s *InvalidNextTokenException) RequestID() string { - return s.RespMetadata.RequestID -} +// 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 limit on the number of resources per account has been exceeded. -type LimitExceededException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + // 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"` - Message_ *string `locationName:"Message" type:"string"` + // The number of times to split the input data. The default is 1. Valid values + // are 1 through 5. + NumberOfBacktestWindows *int64 `type:"integer"` } // String returns the string representation. @@ -13719,7 +14777,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 EvaluationParameters) String() string { return awsutil.Prettify(s) } @@ -13728,58 +14786,34 @@ 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 EvaluationParameters) 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 +// SetBackTestWindowOffset sets the BackTestWindowOffset field's value. +func (s *EvaluationParameters) SetBackTestWindowOffset(v int64) *EvaluationParameters { + s.BackTestWindowOffset = &v + return s } -// RequestID returns the service's response RequestID for request. -func (s *LimitExceededException) RequestID() string { - return s.RespMetadata.RequestID +// SetNumberOfBacktestWindows sets the NumberOfBacktestWindows field's value. +func (s *EvaluationParameters) SetNumberOfBacktestWindows(v int64) *EvaluationParameters { + s.NumberOfBacktestWindows = &v + return s } -type ListDatasetGroupsInput struct { +// The results of evaluating an algorithm. Returned as part of the GetAccuracyMetrics +// response. +type EvaluationResult struct { _ struct{} `type:"structure"` - // The number of items to return in the response. - MaxResults *int64 `min:"1" type:"integer"` + // The Amazon Resource Name (ARN) of the algorithm that was evaluated. + AlgorithmArn *string `type:"string"` - // If the result of the previous request was truncated, the response includes - // a NextToken. To retrieve the next set of results, use the token in the next - // request. Tokens expire after 24 hours. - NextToken *string `min:"1" 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"` } // String returns the string representation. @@ -13787,7 +14821,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 EvaluationResult) String() string { return awsutil.Prettify(s) } @@ -13796,47 +14830,53 @@ 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 EvaluationResult) 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 +// SetAlgorithmArn sets the AlgorithmArn field's value. +func (s *EvaluationResult) SetAlgorithmArn(v string) *EvaluationResult { + s.AlgorithmArn = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListDatasetGroupsInput) SetNextToken(v string) *ListDatasetGroupsInput { - s.NextToken = &v +// SetTestWindows sets the TestWindows field's value. +func (s *EvaluationResult) SetTestWindows(v []*WindowSummary) *EvaluationResult { + s.TestWindows = v return s } -type ListDatasetGroupsOutput struct { +// 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"` - // An array of objects that summarize each dataset group's properties. - DatasetGroups []*DatasetGroupSummary `type:"list"` + // 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"` - // 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"` + // 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 or Parquet 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"` } // String returns the string representation. @@ -13844,7 +14884,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 ExplainabilityConfig) String() string { return awsutil.Prettify(s) } @@ -13853,54 +14893,86 @@ 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 ExplainabilityConfig) GoString() string { return s.String() } -// SetDatasetGroups sets the DatasetGroups field's value. -func (s *ListDatasetGroupsOutput) SetDatasetGroups(v []*DatasetGroupSummary) *ListDatasetGroupsOutput { - s.DatasetGroups = 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 } -// SetNextToken sets the NextToken field's value. -func (s *ListDatasetGroupsOutput) SetNextToken(v string) *ListDatasetGroupsOutput { - s.NextToken = &v +// SetTimePointGranularity sets the TimePointGranularity field's value. +func (s *ExplainabilityConfig) SetTimePointGranularity(v string) *ExplainabilityConfig { + s.TimePointGranularity = &v return s } -type ListDatasetImportJobsInput struct { +// SetTimeSeriesGranularity sets the TimeSeriesGranularity field's value. +func (s *ExplainabilityConfig) SetTimeSeriesGranularity(v string) *ExplainabilityConfig { + s.TimeSeriesGranularity = &v + return s +} + +// 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"` - // 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 + // 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: // - // * 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. + // * CREATE_PENDING - The CreationTime. // - // * Key - The name of the parameter to filter on. Valid values are DatasetArn - // and Status. + // * CREATE_IN_PROGRESS - The current timestamp. // - // * Value - The value to match. + // * CREATE_STOPPING - The current timestamp. // - // For example, to list all dataset import jobs whose status is ACTIVE, you - // specify the following filter: + // * CREATE_STOPPED - When the job stopped. // - // "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ] - Filters []*Filter `type:"list"` + // * ACTIVE or CREATE_FAILED - When the job finished or failed. + LastModificationTime *time.Time `type:"timestamp"` - // The number of items to return in the response. - MaxResults *int64 `min:"1" type:"integer"` + // Information about any errors that may have occurred during the Explainability + // export. + Message *string `type:"string"` - // If the result of the previous request was truncated, the response includes - // a NextToken. To retrieve the next set of results, use the token in the next - // request. Tokens expire after 24 hours. - NextToken *string `min:"1" type:"string"` + // The status of the Explainability export. 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. @@ -13908,7 +14980,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 ExplainabilityExportSummary) String() string { return awsutil.Prettify(s) } @@ -13917,63 +14989,69 @@ 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 ExplainabilityExportSummary) 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)) - } - } - } +// 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 } -// SetFilters sets the Filters field's value. -func (s *ListDatasetImportJobsInput) SetFilters(v []*Filter) *ListDatasetImportJobsInput { - s.Filters = v +// SetExplainabilityExportArn sets the ExplainabilityExportArn field's value. +func (s *ExplainabilityExportSummary) SetExplainabilityExportArn(v string) *ExplainabilityExportSummary { + s.ExplainabilityExportArn = &v return s } -// SetMaxResults sets the MaxResults field's value. -func (s *ListDatasetImportJobsInput) SetMaxResults(v int64) *ListDatasetImportJobsInput { - s.MaxResults = &v +// SetExplainabilityExportName sets the ExplainabilityExportName field's value. +func (s *ExplainabilityExportSummary) SetExplainabilityExportName(v string) *ExplainabilityExportSummary { + s.ExplainabilityExportName = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListDatasetImportJobsInput) SetNextToken(v string) *ListDatasetImportJobsInput { - s.NextToken = &v +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *ExplainabilityExportSummary) SetLastModificationTime(v time.Time) *ExplainabilityExportSummary { + s.LastModificationTime = &v return s } -type ListDatasetImportJobsOutput struct { +// SetMessage sets the Message field's value. +func (s *ExplainabilityExportSummary) SetMessage(v string) *ExplainabilityExportSummary { + s.Message = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *ExplainabilityExportSummary) SetStatus(v string) *ExplainabilityExportSummary { + s.Status = &v + return s +} + +// Provides information about the Explainability resource. +type ExplainabilityInfo struct { _ struct{} `type:"structure"` - // An array of objects that summarize each dataset import job's properties. - DatasetImportJobs []*DatasetImportJobSummary `type:"list"` + // The Amazon Resource Name (ARN) of the Explainability. + ExplainabilityArn *string `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"` + // 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. @@ -13981,7 +15059,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 ExplainabilityInfo) String() string { return awsutil.Prettify(s) } @@ -13990,32 +15068,73 @@ 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 ExplainabilityInfo) GoString() string { return s.String() } -// SetDatasetImportJobs sets the DatasetImportJobs field's value. -func (s *ListDatasetImportJobsOutput) SetDatasetImportJobs(v []*DatasetImportJobSummary) *ListDatasetImportJobsOutput { - s.DatasetImportJobs = v +// SetExplainabilityArn sets the ExplainabilityArn field's value. +func (s *ExplainabilityInfo) SetExplainabilityArn(v string) *ExplainabilityInfo { + s.ExplainabilityArn = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListDatasetImportJobsOutput) SetNextToken(v string) *ListDatasetImportJobsOutput { - s.NextToken = &v +// SetStatus sets the Status field's value. +func (s *ExplainabilityInfo) SetStatus(v string) *ExplainabilityInfo { + s.Status = &v return s } -type ListDatasetsInput struct { +// 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"` - // The number of items to return in the response. - MaxResults *int64 `min:"1" type:"integer"` + // When the Explainability was created. + CreationTime *time.Time `type:"timestamp"` - // 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"` + // The Amazon Resource Name (ARN) of the Explainability. + ExplainabilityArn *string `type:"string"` + + // The configuration settings that define the granularity of time series and + // time points for the Explainability. + ExplainabilityConfig *ExplainabilityConfig `type:"structure"` + + // 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"` + + // 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. @@ -14023,7 +15142,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 ExplainabilitySummary) String() string { return awsutil.Prettify(s) } @@ -14032,104 +15151,94 @@ 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 ExplainabilitySummary) 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"} - 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 +// SetCreationTime sets the CreationTime field's value. +func (s *ExplainabilitySummary) SetCreationTime(v time.Time) *ExplainabilitySummary { + s.CreationTime = &v + return s } -// SetMaxResults sets the MaxResults field's value. -func (s *ListDatasetsInput) SetMaxResults(v int64) *ListDatasetsInput { - s.MaxResults = &v +// SetExplainabilityArn sets the ExplainabilityArn field's value. +func (s *ExplainabilitySummary) SetExplainabilityArn(v string) *ExplainabilitySummary { + s.ExplainabilityArn = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListDatasetsInput) SetNextToken(v string) *ListDatasetsInput { - s.NextToken = &v +// SetExplainabilityConfig sets the ExplainabilityConfig field's value. +func (s *ExplainabilitySummary) SetExplainabilityConfig(v *ExplainabilityConfig) *ExplainabilitySummary { + s.ExplainabilityConfig = v return s } -type ListDatasetsOutput struct { - _ struct{} `type:"structure"` - - // 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. - NextToken *string `min:"1" type:"string"` +// 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 ListDatasetsOutput) 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 ListDatasetsOutput) GoString() string { - return s.String() +// SetMessage sets the Message field's value. +func (s *ExplainabilitySummary) SetMessage(v string) *ExplainabilitySummary { + s.Message = &v + return s } -// SetDatasets sets the Datasets field's value. -func (s *ListDatasetsOutput) SetDatasets(v []*DatasetSummary) *ListDatasetsOutput { - s.Datasets = v +// SetResourceArn sets the ResourceArn field's value. +func (s *ExplainabilitySummary) SetResourceArn(v string) *ExplainabilitySummary { + s.ResourceArn = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListDatasetsOutput) SetNextToken(v string) *ListDatasetsOutput { - s.NextToken = &v +// SetStatus sets the Status field's value. +func (s *ExplainabilitySummary) SetStatus(v string) *ExplainabilitySummary { + s.Status = &v return s } -type ListExplainabilitiesInput struct { +// This object belongs to the CreatePredictor operation. If you created your +// predictor with CreateAutoPredictor, see AttributeConfig. +// +// 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"} +// +// } ] +// +// } +type Featurization 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 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. - // - // * Key - The name of the parameter to filter on. Valid values are ResourceArn - // and Status. + // 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. // - // * Value - The value to match. - Filters []*Filter `type:"list"` - - // The number of items returned in the response. - MaxResults *int64 `min:"1" type:"integer"` + // AttributeName is a required field + AttributeName *string `min:"1" type:"string" required:"true"` - // 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"` + // An array of one FeaturizationMethod object that specifies the feature transformation + // method. + FeaturizationPipeline []*FeaturizationMethod `min:"1" type:"list"` } // String returns the string representation. @@ -14137,7 +15246,7 @@ type ListExplainabilitiesInput 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 ListExplainabilitiesInput) String() string { +func (s Featurization) String() string { return awsutil.Prettify(s) } @@ -14146,26 +15255,29 @@ func (s ListExplainabilitiesInput) 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 ListExplainabilitiesInput) GoString() string { +func (s Featurization) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListExplainabilitiesInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListExplainabilitiesInput"} - if s.MaxResults != nil && *s.MaxResults < 1 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) +func (s *Featurization) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Featurization"} + if s.AttributeName == nil { + invalidParams.Add(request.NewErrParamRequired("AttributeName")) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + if s.AttributeName != nil && len(*s.AttributeName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AttributeName", 1)) } - if s.Filters != nil { - for i, v := range s.Filters { + if s.FeaturizationPipeline != nil && len(s.FeaturizationPipeline) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FeaturizationPipeline", 1)) + } + if s.FeaturizationPipeline != nil { + for i, v := range s.FeaturizationPipeline { if v == nil { continue } if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams)) + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "FeaturizationPipeline", i), err.(request.ErrInvalidParams)) } } } @@ -14176,34 +15288,71 @@ func (s *ListExplainabilitiesInput) Validate() error { return nil } -// SetFilters sets the Filters field's value. -func (s *ListExplainabilitiesInput) SetFilters(v []*Filter) *ListExplainabilitiesInput { - s.Filters = v - return s -} - -// SetMaxResults sets the MaxResults field's value. -func (s *ListExplainabilitiesInput) SetMaxResults(v int64) *ListExplainabilitiesInput { - s.MaxResults = &v +// SetAttributeName sets the AttributeName field's value. +func (s *Featurization) SetAttributeName(v string) *Featurization { + s.AttributeName = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListExplainabilitiesInput) SetNextToken(v string) *ListExplainabilitiesInput { - s.NextToken = &v +// SetFeaturizationPipeline sets the FeaturizationPipeline field's value. +func (s *Featurization) SetFeaturizationPipeline(v []*FeaturizationMethod) *Featurization { + s.FeaturizationPipeline = v return s } -type ListExplainabilitiesOutput struct { +// This object belongs to the CreatePredictor operation. If you created your +// predictor with CreateAutoPredictor, see AttributeConfig. +// +// In a CreatePredictor operation, the specified algorithm trains a model using +// the specified dataset group. You can optionally tell the operation to modify +// data fields prior to training a model. These modifications are referred to +// as featurization. +// +// You define featurization using the FeaturizationConfig object. You specify +// an array of transformations, one for each field that you want to featurize. +// You then include the FeaturizationConfig object in your CreatePredictor request. +// Amazon Forecast applies the featurization to the TARGET_TIME_SERIES and RELATED_TIME_SERIES +// datasets before model training. +// +// You can create multiple featurization configurations. For example, you might +// call the CreatePredictor operation twice by specifying different featurization +// configurations. +type FeaturizationConfig struct { _ struct{} `type:"structure"` - // An array of objects that summarize the properties of each Explainability - // resource. - Explainabilities []*ExplainabilitySummary `type:"list"` + // An array of featurization (transformation) information for the fields of + // a dataset. + Featurizations []*Featurization `min:"1" type:"list"` - // 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"` + // An array of dimension (field) names that specify how to group the generated + // forecast. + // + // For example, suppose that you are generating a forecast for item sales across + // all of your stores, and your dataset contains a store_id field. If you want + // the sales forecast for each item by store, you would specify store_id as + // the dimension. + // + // All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't + // need to be specified in the CreatePredictor request. All forecast dimensions + // specified in the RELATED_TIME_SERIES dataset must be specified in the CreatePredictor + // request. + ForecastDimensions []*string `min:"1" type:"list"` + + // 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. + // + // ForecastFrequency is a required field + ForecastFrequency *string `min:"1" type:"string" required:"true"` } // String returns the string representation. @@ -14211,7 +15360,7 @@ type ListExplainabilitiesOutput 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 ListExplainabilitiesOutput) String() string { +func (s FeaturizationConfig) String() string { return awsutil.Prettify(s) } @@ -14220,83 +15369,32 @@ func (s ListExplainabilitiesOutput) 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 ListExplainabilitiesOutput) GoString() string { - return s.String() -} - -// 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 *ListExplainabilitiesOutput) SetNextToken(v string) *ListExplainabilitiesOutput { - s.NextToken = &v - return s -} - -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 ResourceArn - // 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"` - - // 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 ListExplainabilityExportsInput) 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 ListExplainabilityExportsInput) GoString() string { +func (s FeaturizationConfig) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListExplainabilityExportsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListExplainabilityExportsInput"} - if s.MaxResults != nil && *s.MaxResults < 1 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) +func (s *FeaturizationConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "FeaturizationConfig"} + if s.Featurizations != nil && len(s.Featurizations) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Featurizations", 1)) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + if s.ForecastDimensions != nil && len(s.ForecastDimensions) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ForecastDimensions", 1)) } - if s.Filters != nil { - for i, v := range s.Filters { + 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 { continue } if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams)) + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Featurizations", i), err.(request.ErrInvalidParams)) } } } @@ -14307,34 +15405,76 @@ func (s *ListExplainabilityExportsInput) Validate() error { return nil } -// SetFilters sets the Filters field's value. -func (s *ListExplainabilityExportsInput) SetFilters(v []*Filter) *ListExplainabilityExportsInput { - s.Filters = v +// SetFeaturizations sets the Featurizations field's value. +func (s *FeaturizationConfig) SetFeaturizations(v []*Featurization) *FeaturizationConfig { + s.Featurizations = v return s } -// SetMaxResults sets the MaxResults field's value. -func (s *ListExplainabilityExportsInput) SetMaxResults(v int64) *ListExplainabilityExportsInput { - s.MaxResults = &v +// SetForecastDimensions sets the ForecastDimensions field's value. +func (s *FeaturizationConfig) SetForecastDimensions(v []*string) *FeaturizationConfig { + s.ForecastDimensions = v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListExplainabilityExportsInput) SetNextToken(v string) *ListExplainabilityExportsInput { - s.NextToken = &v +// SetForecastFrequency sets the ForecastFrequency field's value. +func (s *FeaturizationConfig) SetForecastFrequency(v string) *FeaturizationConfig { + s.ForecastFrequency = &v return s } -type ListExplainabilityExportsOutput struct { +// Provides information about the method that featurizes (transforms) a dataset +// field. The method is part of the FeaturizationPipeline of the Featurization +// object. +// +// The following is an example of how you specify a FeaturizationMethod object. +// +// { +// +// "FeaturizationMethodName": "filling", +// +// "FeaturizationMethodParameters": {"aggregation": "sum", "middlefill": "zero", +// "backfill": "zero"} +// +// } +type FeaturizationMethod struct { _ struct{} `type:"structure"` - // An array of objects that summarize the properties of each Explainability - // export. - ExplainabilityExports []*ExplainabilityExportSummary `type:"list"` + // The name of the method. The "filling" method is the only supported method. + // + // FeaturizationMethodName is a required field + FeaturizationMethodName *string `type:"string" required:"true" enum:"FeaturizationMethodName"` - // 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"` + // 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. Bold signifies the + // default value. + // + // * aggregation: sum, avg, first, min, max + // + // * frontfill: none + // + // * middlefill: zero, nan (not a number), value, median, mean, min, max + // + // * backfill: zero, nan, value, median, mean, min, max + // + // The following list shows the parameters and their valid values for a Related + // Time Series featurization method (there are no defaults): + // + // * middlefill: zero, value, median, mean, min, max + // + // * backfill: zero, value, median, mean, min, max + // + // * futurefill: zero, value, median, mean, min, max + // + // 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". + FeaturizationMethodParameters map[string]*string `min:"1" type:"map"` } // String returns the string representation. @@ -14342,7 +15482,7 @@ type ListExplainabilityExportsOutput 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 ListExplainabilityExportsOutput) String() string { +func (s FeaturizationMethod) String() string { return awsutil.Prettify(s) } @@ -14351,55 +15491,60 @@ func (s ListExplainabilityExportsOutput) 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 ListExplainabilityExportsOutput) GoString() string { +func (s FeaturizationMethod) GoString() string { return s.String() } -// SetExplainabilityExports sets the ExplainabilityExports field's value. -func (s *ListExplainabilityExportsOutput) SetExplainabilityExports(v []*ExplainabilityExportSummary) *ListExplainabilityExportsOutput { - s.ExplainabilityExports = v +// Validate inspects the fields of the type to determine if they are valid. +func (s *FeaturizationMethod) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "FeaturizationMethod"} + if s.FeaturizationMethodName == nil { + invalidParams.Add(request.NewErrParamRequired("FeaturizationMethodName")) + } + if s.FeaturizationMethodParameters != nil && len(s.FeaturizationMethodParameters) < 1 { + invalidParams.Add(request.NewErrParamMinLen("FeaturizationMethodParameters", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFeaturizationMethodName sets the FeaturizationMethodName field's value. +func (s *FeaturizationMethod) SetFeaturizationMethodName(v string) *FeaturizationMethod { + s.FeaturizationMethodName = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListExplainabilityExportsOutput) SetNextToken(v string) *ListExplainabilityExportsOutput { - s.NextToken = &v +// SetFeaturizationMethodParameters sets the FeaturizationMethodParameters field's value. +func (s *FeaturizationMethod) SetFeaturizationMethodParameters(v map[string]*string) *FeaturizationMethod { + s.FeaturizationMethodParameters = v return s } -type ListForecastExportJobsInput struct { +// Describes a filter for choosing a subset of objects. Each filter consists +// of a condition and a match statement. The condition is either IS or IS_NOT, +// which specifies whether to include or exclude the objects that match the +// statement, respectively. The match statement consists of a key and a value. +type Filter 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 forecast export jobs 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 forecast export jobs that match the statement, specify - // IS. To exclude matching forecast export jobs, specify IS_NOT. - // - // * Key - The name of the parameter to filter on. Valid values are ForecastArn - // and Status. - // - // * Value - The value to match. - // - // For example, to list all jobs that export a forecast named electricityforecast, - // specify the following filter: + // The condition to apply. To include the objects that match the statement, + // specify IS. To exclude matching objects, specify IS_NOT. // - // "Filters": [ { "Condition": "IS", "Key": "ForecastArn", "Value": "arn:aws:forecast:us-west-2::forecast/electricityforecast" - // } ] - Filters []*Filter `type:"list"` + // Condition is a required field + Condition *string `type:"string" required:"true" enum:"FilterConditionString"` - // The number of items to return in the response. - MaxResults *int64 `min:"1" type:"integer"` + // The name of the parameter to filter on. + // + // Key is a required field + Key *string `type:"string" required:"true"` - // 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"` + // The value to match. + // + // Value is a required field + Value *string `type:"string" required:"true"` } // String returns the string representation. @@ -14407,7 +15552,7 @@ type ListForecastExportJobsInput 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 ListForecastExportJobsInput) String() string { +func (s Filter) String() string { return awsutil.Prettify(s) } @@ -14416,28 +15561,21 @@ func (s ListForecastExportJobsInput) 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 ListForecastExportJobsInput) GoString() string { +func (s Filter) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListForecastExportJobsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListForecastExportJobsInput"} - if s.MaxResults != nil && *s.MaxResults < 1 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) +func (s *Filter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Filter"} + if s.Condition == nil { + invalidParams.Add(request.NewErrParamRequired("Condition")) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + if s.Key == nil { + invalidParams.Add(request.NewErrParamRequired("Key")) } - 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 s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) } if invalidParams.Len() > 0 { @@ -14446,33 +15584,73 @@ func (s *ListForecastExportJobsInput) Validate() error { return nil } -// SetFilters sets the Filters field's value. -func (s *ListForecastExportJobsInput) SetFilters(v []*Filter) *ListForecastExportJobsInput { - s.Filters = v +// SetCondition sets the Condition field's value. +func (s *Filter) SetCondition(v string) *Filter { + s.Condition = &v return s } -// SetMaxResults sets the MaxResults field's value. -func (s *ListForecastExportJobsInput) SetMaxResults(v int64) *ListForecastExportJobsInput { - s.MaxResults = &v +// SetKey sets the Key field's value. +func (s *Filter) SetKey(v string) *Filter { + s.Key = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListForecastExportJobsInput) SetNextToken(v string) *ListForecastExportJobsInput { - s.NextToken = &v +// SetValue sets the Value field's value. +func (s *Filter) SetValue(v string) *Filter { + s.Value = &v return s } -type ListForecastExportJobsOutput struct { +// Provides a summary of the forecast export job properties used in the ListForecastExportJobs +// operation. To get the complete set of properties, call the DescribeForecastExportJob +// operation, and provide the listed ForecastExportJobArn. +type ForecastExportJobSummary struct { _ struct{} `type:"structure"` - // An array of objects that summarize each export job's properties. - ForecastExportJobs []*ForecastExportJobSummary `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"` + // When the forecast export job was created. + CreationTime *time.Time `type:"timestamp"` + + // The path to the Amazon Simple Storage Service (Amazon S3) bucket where the + // forecast is exported. + Destination *DataDestination `type:"structure"` + + // The Amazon Resource Name (ARN) of the forecast export job. + ForecastExportJobArn *string `type:"string"` + + // The name of the forecast export job. + ForecastExportJobName *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 forecast export job. States include: + // + // * ACTIVE + // + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * CREATE_STOPPING, CREATE_STOPPED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // + // The Status of the forecast export job must be ACTIVE before you can access + // the forecast in your S3 bucket. + Status *string `type:"string"` } // String returns the string representation. @@ -14480,7 +15658,7 @@ type ListForecastExportJobsOutput 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 ListForecastExportJobsOutput) String() string { +func (s ForecastExportJobSummary) String() string { return awsutil.Prettify(s) } @@ -14489,55 +15667,107 @@ func (s ListForecastExportJobsOutput) 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 ListForecastExportJobsOutput) GoString() string { +func (s ForecastExportJobSummary) GoString() string { return s.String() } -// SetForecastExportJobs sets the ForecastExportJobs field's value. -func (s *ListForecastExportJobsOutput) SetForecastExportJobs(v []*ForecastExportJobSummary) *ListForecastExportJobsOutput { - s.ForecastExportJobs = v +// SetCreationTime sets the CreationTime field's value. +func (s *ForecastExportJobSummary) SetCreationTime(v time.Time) *ForecastExportJobSummary { + s.CreationTime = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListForecastExportJobsOutput) SetNextToken(v string) *ListForecastExportJobsOutput { - s.NextToken = &v +// SetDestination sets the Destination field's value. +func (s *ForecastExportJobSummary) SetDestination(v *DataDestination) *ForecastExportJobSummary { + s.Destination = v return s } -type ListForecastsInput struct { +// SetForecastExportJobArn sets the ForecastExportJobArn field's value. +func (s *ForecastExportJobSummary) SetForecastExportJobArn(v string) *ForecastExportJobSummary { + s.ForecastExportJobArn = &v + return s +} + +// SetForecastExportJobName sets the ForecastExportJobName field's value. +func (s *ForecastExportJobSummary) SetForecastExportJobName(v string) *ForecastExportJobSummary { + s.ForecastExportJobName = &v + return s +} + +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *ForecastExportJobSummary) SetLastModificationTime(v time.Time) *ForecastExportJobSummary { + s.LastModificationTime = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *ForecastExportJobSummary) SetMessage(v string) *ForecastExportJobSummary { + s.Message = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *ForecastExportJobSummary) SetStatus(v string) *ForecastExportJobSummary { + s.Status = &v + return s +} + +// Provides a summary of the forecast properties used in the ListForecasts operation. +// To get the complete set of properties, call the DescribeForecast operation, +// and provide the ForecastArn that is listed in the summary. +type ForecastSummary 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 forecasts that match the statement from the list, - // respectively. The match statement consists of a key and a value. - // - // Filter properties + // Whether the Forecast was created from an AutoPredictor. + CreatedUsingAutoPredictor *bool `type:"boolean"` + + // When the forecast creation task was created. + CreationTime *time.Time `type:"timestamp"` + + // The Amazon Resource Name (ARN) of the dataset group that provided the data + // used to train the predictor. + DatasetGroupArn *string `type:"string"` + + // The ARN of the forecast. + ForecastArn *string `type:"string"` + + // The name of the forecast. + ForecastName *string `min:"1" type:"string"` + + // The last time the resource was modified. The timestamp depends on the status + // of the job: // - // * Condition - The condition to apply. Valid values are IS and IS_NOT. - // To include the forecasts that match the statement, specify IS. To exclude - // matching forecasts, specify IS_NOT. + // * CREATE_PENDING - The CreationTime. // - // * Key - The name of the parameter to filter on. Valid values are DatasetGroupArn, - // PredictorArn, and Status. + // * CREATE_IN_PROGRESS - The current timestamp. // - // * Value - The value to match. + // * CREATE_STOPPING - The current timestamp. // - // For example, to list all forecasts whose status is not ACTIVE, you would - // specify: + // * CREATE_STOPPED - When the job stopped. // - // "Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" - // } ] - Filters []*Filter `type:"list"` + // * ACTIVE or CREATE_FAILED - When the job finished or failed. + LastModificationTime *time.Time `type:"timestamp"` - // The number of items to return in the response. - MaxResults *int64 `min:"1" type:"integer"` + // If an error occurred, an informational message about the error. + Message *string `type:"string"` - // If the result of the previous request was truncated, the response includes - // a NextToken. To retrieve the next set of results, use the token in the next - // request. Tokens expire after 24 hours. - NextToken *string `min:"1" type:"string"` + // The ARN of the predictor used to generate the forecast. + PredictorArn *string `type:"string"` + + // The status of the forecast. States include: + // + // * ACTIVE + // + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * CREATE_STOPPING, CREATE_STOPPED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // + // The Status of the forecast must be ACTIVE before you can query or export + // the forecast. + Status *string `type:"string"` } // String returns the string representation. @@ -14545,7 +15775,7 @@ type ListForecastsInput 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 ListForecastsInput) String() string { +func (s ForecastSummary) String() string { return awsutil.Prettify(s) } @@ -14554,63 +15784,71 @@ func (s ListForecastsInput) 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 ListForecastsInput) GoString() string { +func (s ForecastSummary) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *ListForecastsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListForecastsInput"} - 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)) - } - } - } +// SetCreatedUsingAutoPredictor sets the CreatedUsingAutoPredictor field's value. +func (s *ForecastSummary) SetCreatedUsingAutoPredictor(v bool) *ForecastSummary { + s.CreatedUsingAutoPredictor = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetCreationTime sets the CreationTime field's value. +func (s *ForecastSummary) SetCreationTime(v time.Time) *ForecastSummary { + s.CreationTime = &v + return s } -// SetFilters sets the Filters field's value. -func (s *ListForecastsInput) SetFilters(v []*Filter) *ListForecastsInput { - s.Filters = v +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *ForecastSummary) SetDatasetGroupArn(v string) *ForecastSummary { + s.DatasetGroupArn = &v return s } -// SetMaxResults sets the MaxResults field's value. -func (s *ListForecastsInput) SetMaxResults(v int64) *ListForecastsInput { - s.MaxResults = &v +// SetForecastArn sets the ForecastArn field's value. +func (s *ForecastSummary) SetForecastArn(v string) *ForecastSummary { + s.ForecastArn = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListForecastsInput) SetNextToken(v string) *ListForecastsInput { - s.NextToken = &v +// SetForecastName sets the ForecastName field's value. +func (s *ForecastSummary) SetForecastName(v string) *ForecastSummary { + s.ForecastName = &v return s } -type ListForecastsOutput struct { - _ struct{} `type:"structure"` +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *ForecastSummary) SetLastModificationTime(v time.Time) *ForecastSummary { + s.LastModificationTime = &v + return s +} - // An array of objects that summarize each forecast's properties. - Forecasts []*ForecastSummary `type:"list"` +// SetMessage sets the Message field's value. +func (s *ForecastSummary) SetMessage(v string) *ForecastSummary { + s.Message = &v + return s +} - // 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"` +// SetPredictorArn sets the PredictorArn field's value. +func (s *ForecastSummary) SetPredictorArn(v string) *ForecastSummary { + s.PredictorArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *ForecastSummary) SetStatus(v string) *ForecastSummary { + s.Status = &v + return s +} + +type GetAccuracyMetricsInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the predictor to get metrics for. + // + // PredictorArn is a required field + PredictorArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -14618,7 +15856,7 @@ type ListForecastsOutput 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 ListForecastsOutput) String() string { +func (s GetAccuracyMetricsInput) String() string { return awsutil.Prettify(s) } @@ -14627,57 +15865,51 @@ func (s ListForecastsOutput) 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 ListForecastsOutput) GoString() string { +func (s GetAccuracyMetricsInput) GoString() string { return s.String() } -// SetForecasts sets the Forecasts field's value. -func (s *ListForecastsOutput) SetForecasts(v []*ForecastSummary) *ListForecastsOutput { - s.Forecasts = v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetAccuracyMetricsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetAccuracyMetricsInput"} + if s.PredictorArn == nil { + invalidParams.Add(request.NewErrParamRequired("PredictorArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetNextToken sets the NextToken field's value. -func (s *ListForecastsOutput) SetNextToken(v string) *ListForecastsOutput { - s.NextToken = &v +// SetPredictorArn sets the PredictorArn field's value. +func (s *GetAccuracyMetricsInput) SetPredictorArn(v string) *GetAccuracyMetricsInput { + s.PredictorArn = &v return s } -type ListMonitorEvaluationsInput struct { +type GetAccuracyMetricsOutput 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 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. - // - // * Key - The name of the parameter to filter on. The only valid value is - // EvaluationState. // - // * Value - The value to match. Valid values are only SUCCESS or FAILURE. + // The LatencyOptimized AutoML override strategy is only available in private + // beta. Contact AWS Support or your account manager to learn more about access + // privileges. // - // For example, to list only successful monitor evaluations, you would specify: + // The AutoML strategy used to train the predictor. Unless LatencyOptimized + // is specified, the AutoML strategy optimizes predictor accuracy. // - // "Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" - // } ] - Filters []*Filter `type:"list"` + // This parameter is only valid for predictors trained using AutoML. + AutoMLOverrideStrategy *string `type:"string" enum:"AutoMLOverrideStrategy"` - // The maximum number of monitoring results to return. - MaxResults *int64 `min:"1" type:"integer"` + // Whether the predictor was created with CreateAutoPredictor. + IsAutoPredictor *bool `type:"boolean"` - // The Amazon Resource Name (ARN) of the monitor resource to get results from. - // - // MonitorArn is a required field - MonitorArn *string `type:"string" required:"true"` + // The accuracy metric used to optimize the predictor. + OptimizationMetric *string `type:"string" enum:"OptimizationMetric"` - // 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"` + // An array of results from evaluating the predictor. + PredictorEvaluationResults []*EvaluationResult `type:"list"` } // String returns the string representation. @@ -14685,7 +15917,7 @@ type ListMonitorEvaluationsInput 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 ListMonitorEvaluationsInput) String() string { +func (s GetAccuracyMetricsOutput) String() string { return awsutil.Prettify(s) } @@ -14694,78 +15926,52 @@ func (s ListMonitorEvaluationsInput) 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 ListMonitorEvaluationsInput) GoString() string { +func (s GetAccuracyMetricsOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *ListMonitorEvaluationsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListMonitorEvaluationsInput"} - if s.MaxResults != nil && *s.MaxResults < 1 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) - } - if s.MonitorArn == nil { - invalidParams.Add(request.NewErrParamRequired("MonitorArn")) - } - 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 -} - -// SetFilters sets the Filters field's value. -func (s *ListMonitorEvaluationsInput) SetFilters(v []*Filter) *ListMonitorEvaluationsInput { - s.Filters = v +// SetAutoMLOverrideStrategy sets the AutoMLOverrideStrategy field's value. +func (s *GetAccuracyMetricsOutput) SetAutoMLOverrideStrategy(v string) *GetAccuracyMetricsOutput { + s.AutoMLOverrideStrategy = &v return s } -// SetMaxResults sets the MaxResults field's value. -func (s *ListMonitorEvaluationsInput) SetMaxResults(v int64) *ListMonitorEvaluationsInput { - s.MaxResults = &v +// SetIsAutoPredictor sets the IsAutoPredictor field's value. +func (s *GetAccuracyMetricsOutput) SetIsAutoPredictor(v bool) *GetAccuracyMetricsOutput { + s.IsAutoPredictor = &v return s } -// SetMonitorArn sets the MonitorArn field's value. -func (s *ListMonitorEvaluationsInput) SetMonitorArn(v string) *ListMonitorEvaluationsInput { - s.MonitorArn = &v +// SetOptimizationMetric sets the OptimizationMetric field's value. +func (s *GetAccuracyMetricsOutput) SetOptimizationMetric(v string) *GetAccuracyMetricsOutput { + s.OptimizationMetric = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListMonitorEvaluationsInput) SetNextToken(v string) *ListMonitorEvaluationsInput { - s.NextToken = &v +// SetPredictorEvaluationResults sets the PredictorEvaluationResults field's value. +func (s *GetAccuracyMetricsOutput) SetPredictorEvaluationResults(v []*EvaluationResult) *GetAccuracyMetricsOutput { + s.PredictorEvaluationResults = v return s } -type ListMonitorEvaluationsOutput struct { +// Configuration information for a hyperparameter tuning job. You specify this +// object in the CreatePredictor request. +// +// A hyperparameter is a parameter that governs the model training process. +// You set hyperparameters before training starts, unlike model parameters, +// which are determined during training. The values of the hyperparameters effect +// which values are chosen for the model parameters. +// +// In a hyperparameter tuning job, Amazon Forecast chooses the set of hyperparameter +// values that optimize a specified metric. Forecast accomplishes this by running +// many training jobs over a range of hyperparameter values. The optimum set +// of values depends on the algorithm, the training data, and the specified +// metric objective. +type HyperParameterTuningJobConfig struct { _ struct{} `type:"structure"` - // If the response is truncated, Amazon Forecast returns this token. 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"` - - // The monitoring results and predictor events collected by the monitor resource - // during different windows of time. - // - // For information about monitoring see Viewing Monitoring Results (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html). - // For more information about retrieving monitoring results see Viewing Monitoring - // Results (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html). - PredictorMonitorEvaluations []*PredictorMonitorEvaluation `type:"list"` + // Specifies the ranges of valid values for the hyperparameters. + ParameterRanges *ParameterRanges `type:"structure"` } // String returns the string representation. @@ -14773,7 +15979,7 @@ type ListMonitorEvaluationsOutput 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 ListMonitorEvaluationsOutput) String() string { +func (s HyperParameterTuningJobConfig) String() string { return awsutil.Prettify(s) } @@ -14782,51 +15988,48 @@ func (s ListMonitorEvaluationsOutput) 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 ListMonitorEvaluationsOutput) GoString() string { +func (s HyperParameterTuningJobConfig) GoString() string { return s.String() } -// SetNextToken sets the NextToken field's value. -func (s *ListMonitorEvaluationsOutput) SetNextToken(v string) *ListMonitorEvaluationsOutput { - s.NextToken = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *HyperParameterTuningJobConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "HyperParameterTuningJobConfig"} + if s.ParameterRanges != nil { + if err := s.ParameterRanges.Validate(); err != nil { + invalidParams.AddNested("ParameterRanges", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetPredictorMonitorEvaluations sets the PredictorMonitorEvaluations field's value. -func (s *ListMonitorEvaluationsOutput) SetPredictorMonitorEvaluations(v []*PredictorMonitorEvaluation) *ListMonitorEvaluationsOutput { - s.PredictorMonitorEvaluations = v +// SetParameterRanges sets the ParameterRanges field's value. +func (s *HyperParameterTuningJobConfig) SetParameterRanges(v *ParameterRanges) *HyperParameterTuningJobConfig { + s.ParameterRanges = v return s } -type ListMonitorsInput struct { +// This object belongs to the CreatePredictor operation. If you created your +// predictor with CreateAutoPredictor, see DataConfig. +// +// The data used to train a predictor. The data includes a dataset group and +// any supplementary features. You specify this object in the CreatePredictor +// request. +type InputDataConfig 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 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. - // - // * Key - The name of the parameter to filter on. The only valid value is - // Status. - // - // * Value - The value to match. - // - // For example, to list all monitors who's status is ACTIVE, you would specify: + // The Amazon Resource Name (ARN) of the dataset group. // - // "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ] - Filters []*Filter `type:"list"` - - // The maximum number of monitors to include in the response. - MaxResults *int64 `min:"1" type:"integer"` + // DatasetGroupArn is a required field + DatasetGroupArn *string `type:"string" required:"true"` - // 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"` + // An array of supplementary features. The only supported feature is a holiday + // calendar. + SupplementaryFeatures []*SupplementaryFeature `min:"1" type:"list"` } // String returns the string representation. @@ -14834,7 +16037,7 @@ type ListMonitorsInput 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 ListMonitorsInput) String() string { +func (s InputDataConfig) String() string { return awsutil.Prettify(s) } @@ -14843,26 +16046,26 @@ func (s ListMonitorsInput) 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 ListMonitorsInput) GoString() string { +func (s InputDataConfig) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListMonitorsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListMonitorsInput"} - if s.MaxResults != nil && *s.MaxResults < 1 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) +func (s *InputDataConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "InputDataConfig"} + if s.DatasetGroupArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn")) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + if s.SupplementaryFeatures != nil && len(s.SupplementaryFeatures) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SupplementaryFeatures", 1)) } - if s.Filters != nil { - for i, v := range s.Filters { + if s.SupplementaryFeatures != nil { + for i, v := range s.SupplementaryFeatures { if v == nil { continue } if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams)) + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "SupplementaryFeatures", i), err.(request.ErrInvalidParams)) } } } @@ -14873,93 +16076,68 @@ func (s *ListMonitorsInput) Validate() error { return nil } -// SetFilters sets the Filters field's value. -func (s *ListMonitorsInput) SetFilters(v []*Filter) *ListMonitorsInput { - s.Filters = v +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *InputDataConfig) SetDatasetGroupArn(v string) *InputDataConfig { + s.DatasetGroupArn = &v return s } -// SetMaxResults sets the MaxResults field's value. -func (s *ListMonitorsInput) SetMaxResults(v int64) *ListMonitorsInput { - s.MaxResults = &v +// SetSupplementaryFeatures sets the SupplementaryFeatures field's value. +func (s *InputDataConfig) SetSupplementaryFeatures(v []*SupplementaryFeature) *InputDataConfig { + s.SupplementaryFeatures = v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListMonitorsInput) SetNextToken(v string) *ListMonitorsInput { - s.NextToken = &v - return s -} +// Specifies an integer hyperparameter and it's range of tunable values. This +// object is part of the ParameterRanges object. +type IntegerParameterRange struct { + _ struct{} `type:"structure"` -type ListMonitorsOutput struct { - _ struct{} `type:"structure"` - - // An array of objects that summarize each monitor's properties. - Monitors []*MonitorSummary `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 ListMonitorsOutput) 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 ListMonitorsOutput) GoString() string { - return s.String() -} - -// SetMonitors sets the Monitors field's value. -func (s *ListMonitorsOutput) SetMonitors(v []*MonitorSummary) *ListMonitorsOutput { - s.Monitors = v - return s -} + // The maximum tunable value of the hyperparameter. + // + // MaxValue is a required field + MaxValue *int64 `type:"integer" required:"true"` -// SetNextToken sets the NextToken field's value. -func (s *ListMonitorsOutput) SetNextToken(v string) *ListMonitorsOutput { - s.NextToken = &v - return s -} + // The minimum tunable value of the hyperparameter. + // + // MinValue is a required field + MinValue *int64 `type:"integer" required:"true"` -type ListPredictorBacktestExportJobsInput struct { - _ struct{} `type:"structure"` + // The name of the hyperparameter to tune. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` - // 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. + // The scale that hyperparameter tuning uses to search the hyperparameter range. + // Valid values: // - // Filter properties + // Auto // - // * Condition - The condition to apply. Valid values are IS and IS_NOT. - // To include the predictor backtest export jobs that match the statement, - // specify IS. To exclude matching predictor backtest export jobs, specify - // IS_NOT. + // Amazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter. // - // * Key - The name of the parameter to filter on. Valid values are PredictorArn - // and Status. + // Linear // - // * Value - The value to match. - 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"` + // Hyperparameter tuning searches the values in the hyperparameter range by + // using a linear scale. + // + // Logarithmic + // + // Hyperparameter tuning searches the values in the hyperparameter range by + // using a logarithmic scale. + // + // Logarithmic scaling works only for ranges that have values greater than 0. + // + // ReverseLogarithmic + // + // Not supported for IntegerParameterRange. + // + // Reverse logarithmic scaling works only for ranges that are entirely within + // the range 0 <= x < 1.0. + // + // For information about choosing a hyperparameter scale, see Hyperparameter + // Scaling (http://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html#scaling-type). + // One of the following values: + ScalingType *string `type:"string" enum:"ScalingType"` } // String returns the string representation. @@ -14967,7 +16145,7 @@ type ListPredictorBacktestExportJobsInput 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 ListPredictorBacktestExportJobsInput) String() string { +func (s IntegerParameterRange) String() string { return awsutil.Prettify(s) } @@ -14976,28 +16154,24 @@ func (s ListPredictorBacktestExportJobsInput) 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 ListPredictorBacktestExportJobsInput) GoString() string { +func (s IntegerParameterRange) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListPredictorBacktestExportJobsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListPredictorBacktestExportJobsInput"} - if s.MaxResults != nil && *s.MaxResults < 1 { - invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) +func (s *IntegerParameterRange) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "IntegerParameterRange"} + if s.MaxValue == nil { + invalidParams.Add(request.NewErrParamRequired("MaxValue")) } - if s.NextToken != nil && len(*s.NextToken) < 1 { - invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + if s.MinValue == nil { + invalidParams.Add(request.NewErrParamRequired("MinValue")) } - 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 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 { @@ -15006,34 +16180,37 @@ func (s *ListPredictorBacktestExportJobsInput) Validate() error { return nil } -// SetFilters sets the Filters field's value. -func (s *ListPredictorBacktestExportJobsInput) SetFilters(v []*Filter) *ListPredictorBacktestExportJobsInput { - s.Filters = v +// SetMaxValue sets the MaxValue field's value. +func (s *IntegerParameterRange) SetMaxValue(v int64) *IntegerParameterRange { + s.MaxValue = &v return s } -// SetMaxResults sets the MaxResults field's value. -func (s *ListPredictorBacktestExportJobsInput) SetMaxResults(v int64) *ListPredictorBacktestExportJobsInput { - s.MaxResults = &v +// SetMinValue sets the MinValue field's value. +func (s *IntegerParameterRange) SetMinValue(v int64) *IntegerParameterRange { + s.MinValue = &v return s } -// SetNextToken sets the NextToken field's value. -func (s *ListPredictorBacktestExportJobsInput) SetNextToken(v string) *ListPredictorBacktestExportJobsInput { - s.NextToken = &v +// SetName sets the Name field's value. +func (s *IntegerParameterRange) SetName(v string) *IntegerParameterRange { + s.Name = &v return s } -type ListPredictorBacktestExportJobsOutput struct { - _ struct{} `type:"structure"` +// SetScalingType sets the ScalingType field's value. +func (s *IntegerParameterRange) SetScalingType(v string) *IntegerParameterRange { + s.ScalingType = &v + return s +} - // 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"` +// 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:"-"` - // An array of objects that summarize the properties of each predictor backtest - // export job. - PredictorBacktestExportJobs []*PredictorBacktestExportJobSummary `type:"list"` + Message_ *string `locationName:"Message" type:"string"` } // String returns the string representation. @@ -15041,7 +16218,7 @@ type ListPredictorBacktestExportJobsOutput 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 ListPredictorBacktestExportJobsOutput) String() string { +func (s InvalidInputException) String() string { return awsutil.Prettify(s) } @@ -15050,53 +16227,54 @@ func (s ListPredictorBacktestExportJobsOutput) 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 ListPredictorBacktestExportJobsOutput) GoString() string { +func (s InvalidInputException) GoString() string { return s.String() } -// SetNextToken sets the NextToken field's value. -func (s *ListPredictorBacktestExportJobsOutput) SetNextToken(v string) *ListPredictorBacktestExportJobsOutput { - s.NextToken = &v - return s +func newErrorInvalidInputException(v protocol.ResponseMetadata) error { + return &InvalidInputException{ + RespMetadata: v, + } } -// SetPredictorBacktestExportJobs sets the PredictorBacktestExportJobs field's value. -func (s *ListPredictorBacktestExportJobsOutput) SetPredictorBacktestExportJobs(v []*PredictorBacktestExportJobSummary) *ListPredictorBacktestExportJobsOutput { - s.PredictorBacktestExportJobs = v - return s +// Code returns the exception type name. +func (s *InvalidInputException) Code() string { + return "InvalidInputException" } -type ListPredictorsInput struct { - _ struct{} `type:"structure"` +// Message returns the exception's message. +func (s *InvalidInputException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} - // An array of filters. For each filter, you provide a condition and a match - // statement. The condition is either IS or IS_NOT, which specifies whether - // to include or exclude the predictors that match the statement from the list, - // 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 predictors that match the statement, specify IS. To exclude - // matching predictors, specify IS_NOT. - // - // * Key - The name of the parameter to filter on. Valid values are DatasetGroupArn - // and Status. - // - // * Value - The value to match. - // - // For example, to list all predictors whose status is ACTIVE, you would specify: - // - // "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ] - Filters []*Filter `type:"list"` +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InvalidInputException) OrigErr() error { + return nil +} - // The number of items to return in the response. - MaxResults *int64 `min:"1" type:"integer"` +func (s *InvalidInputException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} - // 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"` +// Status code returns the HTTP status code for the request's response error. +func (s *InvalidInputException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *InvalidInputException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The token is not valid. Tokens expire after 24 hours. +type InvalidNextTokenException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" type:"string"` } // String returns the string representation. @@ -15104,7 +16282,7 @@ type ListPredictorsInput 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 ListPredictorsInput) String() string { +func (s InvalidNextTokenException) String() string { return awsutil.Prettify(s) } @@ -15113,63 +16291,54 @@ func (s ListPredictorsInput) 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 ListPredictorsInput) GoString() string { +func (s InvalidNextTokenException) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *ListPredictorsInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListPredictorsInput"} - 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)) - } - } +func newErrorInvalidNextTokenException(v protocol.ResponseMetadata) error { + return &InvalidNextTokenException{ + RespMetadata: v, } +} - if invalidParams.Len() > 0 { - return invalidParams +// Code returns the exception type name. +func (s *InvalidNextTokenException) Code() string { + return "InvalidNextTokenException" +} + +// Message returns the exception's message. +func (s *InvalidNextTokenException) Message() string { + if s.Message_ != nil { + return *s.Message_ } - return nil + return "" } -// SetFilters sets the Filters field's value. -func (s *ListPredictorsInput) SetFilters(v []*Filter) *ListPredictorsInput { - s.Filters = v - return s +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InvalidNextTokenException) OrigErr() error { + return nil } -// SetMaxResults sets the MaxResults field's value. -func (s *ListPredictorsInput) SetMaxResults(v int64) *ListPredictorsInput { - s.MaxResults = &v - return s +func (s *InvalidNextTokenException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) } -// SetNextToken sets the NextToken field's value. -func (s *ListPredictorsInput) SetNextToken(v string) *ListPredictorsInput { - s.NextToken = &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 } -type ListPredictorsOutput struct { - _ struct{} `type:"structure"` +// RequestID returns the service's response RequestID for request. +func (s *InvalidNextTokenException) RequestID() string { + return s.RespMetadata.RequestID +} - // 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"` +// 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 predictor's properties. - Predictors []*PredictorSummary `type:"list"` + Message_ *string `locationName:"Message" type:"string"` } // String returns the string representation. @@ -15177,7 +16346,7 @@ type ListPredictorsOutput 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 ListPredictorsOutput) String() string { +func (s LimitExceededException) String() string { return awsutil.Prettify(s) } @@ -15186,30 +16355,58 @@ func (s ListPredictorsOutput) 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 ListPredictorsOutput) GoString() string { +func (s LimitExceededException) GoString() string { return s.String() } -// SetNextToken sets the NextToken field's value. -func (s *ListPredictorsOutput) SetNextToken(v string) *ListPredictorsOutput { - s.NextToken = &v - return s +func newErrorLimitExceededException(v protocol.ResponseMetadata) error { + return &LimitExceededException{ + RespMetadata: v, + } } -// SetPredictors sets the Predictors field's value. -func (s *ListPredictorsOutput) SetPredictors(v []*PredictorSummary) *ListPredictorsOutput { - s.Predictors = v - return s +// Code returns the exception type name. +func (s *LimitExceededException) Code() string { + return "LimitExceededException" } -type ListTagsForResourceInput struct { +// 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 +} + +// 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 Amazon Resource Name (ARN) that identifies the resource for which to - // list the tags. - // - // ResourceArn is a required field - ResourceArn *string `type:"string" required:"true"` + // 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. @@ -15217,7 +16414,7 @@ type ListTagsForResourceInput 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 ListTagsForResourceInput) String() string { +func (s ListDatasetGroupsInput) String() string { return awsutil.Prettify(s) } @@ -15226,15 +16423,18 @@ func (s ListTagsForResourceInput) 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 ListTagsForResourceInput) GoString() string { +func (s ListDatasetGroupsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ListTagsForResourceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} - if s.ResourceArn == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceArn")) +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 { @@ -15243,57 +16443,27 @@ func (s *ListTagsForResourceInput) Validate() error { return nil } -// SetResourceArn sets the ResourceArn field's value. -func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { - s.ResourceArn = &v +// SetMaxResults sets the MaxResults field's value. +func (s *ListDatasetGroupsInput) SetMaxResults(v int64) *ListDatasetGroupsInput { + s.MaxResults = &v return s } -type ListTagsForResourceOutput struct { - _ struct{} `type:"structure"` - - // The tags for the resource. - 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 ListTagsForResourceOutput) 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 ListTagsForResourceOutput) GoString() string { - return s.String() -} - -// SetTags sets the Tags field's value. -func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput { - s.Tags = v +// SetNextToken sets the NextToken field's value. +func (s *ListDatasetGroupsInput) SetNextToken(v string) *ListDatasetGroupsInput { + s.NextToken = &v return s } -// An individual metric Forecast calculated when monitoring predictor usage. -// You can compare the value for this metric to the metric's value in the Baseline -// to see how your predictor's performance is changing. -// -// For more information about metrics generated by Forecast see Evaluating Predictor -// Accuracy (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) -type MetricResult struct { +type ListDatasetGroupsOutput struct { _ struct{} `type:"structure"` - // The name of the metric. - MetricName *string `type:"string"` + // An array of objects that summarize each dataset group's properties. + DatasetGroups []*DatasetGroupSummary `type:"list"` - // The value for the metric. - MetricValue *float64 `type:"double"` + // 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. @@ -15301,7 +16471,7 @@ type MetricResult 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 MetricResult) String() string { +func (s ListDatasetGroupsOutput) String() string { return awsutil.Prettify(s) } @@ -15310,44 +16480,54 @@ func (s MetricResult) 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 MetricResult) GoString() string { +func (s ListDatasetGroupsOutput) GoString() string { return s.String() } -// SetMetricName sets the MetricName field's value. -func (s *MetricResult) SetMetricName(v string) *MetricResult { - s.MetricName = &v +// SetDatasetGroups sets the DatasetGroups field's value. +func (s *ListDatasetGroupsOutput) SetDatasetGroups(v []*DatasetGroupSummary) *ListDatasetGroupsOutput { + s.DatasetGroups = v return s } -// SetMetricValue sets the MetricValue field's value. -func (s *MetricResult) SetMetricValue(v float64) *MetricResult { - s.MetricValue = &v +// SetNextToken sets the NextToken field's value. +func (s *ListDatasetGroupsOutput) SetNextToken(v string) *ListDatasetGroupsOutput { + s.NextToken = &v return s } -// Provides metrics that are used to evaluate the performance of a predictor. -// This object is part of the WindowSummary object. -type Metrics struct { +type ListDatasetImportJobsInput struct { _ struct{} `type:"structure"` - // The average value of all weighted quantile losses. - AverageWeightedQuantileLoss *float64 `type:"double"` - - // Provides detailed error metrics for each forecast type. Metrics include root-mean - // square-error (RMSE), mean absolute percentage error (MAPE), mean absolute - // scaled error (MASE), and weighted average percentage error (WAPE). - ErrorMetrics []*ErrorMetric `type:"list"` - - // The root-mean-square error (RMSE). + // 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. // - // Deprecated: This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPE - RMSE *float64 `deprecated:"true" type:"double"` + // 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"` - // An array of weighted quantile losses. Quantiles divide a probability distribution - // into regions of equal probability. The distribution in this case is the loss - // function. - WeightedQuantileLosses []*WeightedQuantileLoss `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. @@ -15355,7 +16535,7 @@ type Metrics 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 Metrics) String() string { +func (s ListDatasetImportJobsInput) String() string { return awsutil.Prettify(s) } @@ -15364,42 +16544,63 @@ func (s Metrics) 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 Metrics) GoString() string { +func (s ListDatasetImportJobsInput) GoString() string { return s.String() } -// SetAverageWeightedQuantileLoss sets the AverageWeightedQuantileLoss field's value. -func (s *Metrics) SetAverageWeightedQuantileLoss(v float64) *Metrics { - s.AverageWeightedQuantileLoss = &v - return s +// 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 } -// SetErrorMetrics sets the ErrorMetrics field's value. -func (s *Metrics) SetErrorMetrics(v []*ErrorMetric) *Metrics { - s.ErrorMetrics = v +// SetFilters sets the Filters field's value. +func (s *ListDatasetImportJobsInput) SetFilters(v []*Filter) *ListDatasetImportJobsInput { + s.Filters = v return s } -// SetRMSE sets the RMSE field's value. -func (s *Metrics) SetRMSE(v float64) *Metrics { - s.RMSE = &v +// SetMaxResults sets the MaxResults field's value. +func (s *ListDatasetImportJobsInput) SetMaxResults(v int64) *ListDatasetImportJobsInput { + s.MaxResults = &v return s } -// SetWeightedQuantileLosses sets the WeightedQuantileLosses field's value. -func (s *Metrics) SetWeightedQuantileLosses(v []*WeightedQuantileLoss) *Metrics { - s.WeightedQuantileLosses = v +// SetNextToken sets the NextToken field's value. +func (s *ListDatasetImportJobsInput) SetNextToken(v string) *ListDatasetImportJobsInput { + s.NextToken = &v return s } -// The configuration details for the predictor monitor. -type MonitorConfig struct { +type ListDatasetImportJobsOutput struct { _ struct{} `type:"structure"` - // The name of the monitor resource. - // - // MonitorName is a required field - MonitorName *string `min:"1" type:"string" required:"true"` + // An array of objects that summarize each dataset import job's properties. + DatasetImportJobs []*DatasetImportJobSummary `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. @@ -15407,7 +16608,7 @@ type MonitorConfig 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 MonitorConfig) String() string { +func (s ListDatasetImportJobsOutput) String() string { return awsutil.Prettify(s) } @@ -15416,46 +16617,32 @@ func (s MonitorConfig) 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 MonitorConfig) GoString() string { +func (s ListDatasetImportJobsOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *MonitorConfig) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "MonitorConfig"} - if s.MonitorName == nil { - invalidParams.Add(request.NewErrParamRequired("MonitorName")) - } - if s.MonitorName != nil && len(*s.MonitorName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("MonitorName", 1)) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetDatasetImportJobs sets the DatasetImportJobs field's value. +func (s *ListDatasetImportJobsOutput) SetDatasetImportJobs(v []*DatasetImportJobSummary) *ListDatasetImportJobsOutput { + s.DatasetImportJobs = v + return s } -// SetMonitorName sets the MonitorName field's value. -func (s *MonitorConfig) SetMonitorName(v string) *MonitorConfig { - s.MonitorName = &v +// SetNextToken sets the NextToken field's value. +func (s *ListDatasetImportJobsOutput) SetNextToken(v string) *ListDatasetImportJobsOutput { + s.NextToken = &v return s } -// The source of the data the monitor used during the evaluation. -type MonitorDataSource struct { +type ListDatasetsInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the dataset import job used to import the - // data that initiated the monitor evaluation. - DatasetImportJobArn *string `type:"string"` - - // The Amazon Resource Name (ARN) of the forecast the monitor used during the - // evaluation. - ForecastArn *string `type:"string"` + // The number of items to return in the response. + MaxResults *int64 `min:"1" type:"integer"` - // The Amazon Resource Name (ARN) of the predictor resource you are monitoring. - PredictorArn *string `type:"string"` + // If the result of the previous request was truncated, the response includes + // a NextToken. To retrieve the next set of results, use the token in the next + // request. Tokens expire after 24 hours. + NextToken *string `min:"1" type:"string"` } // String returns the string representation. @@ -15463,7 +16650,7 @@ type MonitorDataSource 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 MonitorDataSource) String() string { +func (s ListDatasetsInput) String() string { return awsutil.Prettify(s) } @@ -15472,47 +16659,47 @@ func (s MonitorDataSource) 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 MonitorDataSource) GoString() string { +func (s ListDatasetsInput) GoString() string { return s.String() } -// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. -func (s *MonitorDataSource) SetDatasetImportJobArn(v string) *MonitorDataSource { - s.DatasetImportJobArn = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListDatasetsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDatasetsInput"} + 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 } -// SetForecastArn sets the ForecastArn field's value. -func (s *MonitorDataSource) SetForecastArn(v string) *MonitorDataSource { - s.ForecastArn = &v +// SetMaxResults sets the MaxResults field's value. +func (s *ListDatasetsInput) SetMaxResults(v int64) *ListDatasetsInput { + s.MaxResults = &v return s } -// SetPredictorArn sets the PredictorArn field's value. -func (s *MonitorDataSource) SetPredictorArn(v string) *MonitorDataSource { - s.PredictorArn = &v +// SetNextToken sets the NextToken field's value. +func (s *ListDatasetsInput) SetNextToken(v string) *ListDatasetsInput { + s.NextToken = &v return s } -// Provides information about the monitor resource. -type MonitorInfo struct { +type ListDatasetsOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the monitor resource. - MonitorArn *string `type:"string"` + // An array of objects that summarize each dataset's properties. + Datasets []*DatasetSummary `type:"list"` - // The status of the monitor. States include: - // - // * ACTIVE - // - // * ACTIVE_STOPPING, ACTIVE_STOPPED - // - // * UPDATE_IN_PROGRESS - // - // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - Status *string `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. @@ -15520,7 +16707,7 @@ type MonitorInfo 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 MonitorInfo) String() string { +func (s ListDatasetsOutput) String() string { return awsutil.Prettify(s) } @@ -15529,64 +16716,47 @@ func (s MonitorInfo) 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 MonitorInfo) GoString() string { +func (s ListDatasetsOutput) GoString() string { return s.String() } -// SetMonitorArn sets the MonitorArn field's value. -func (s *MonitorInfo) SetMonitorArn(v string) *MonitorInfo { - s.MonitorArn = &v +// SetDatasets sets the Datasets field's value. +func (s *ListDatasetsOutput) SetDatasets(v []*DatasetSummary) *ListDatasetsOutput { + s.Datasets = v return s } -// SetStatus sets the Status field's value. -func (s *MonitorInfo) SetStatus(v string) *MonitorInfo { - s.Status = &v +// SetNextToken sets the NextToken field's value. +func (s *ListDatasetsOutput) SetNextToken(v string) *ListDatasetsOutput { + s.NextToken = &v return s } -// Provides a summary of the monitor properties used in the ListMonitors operation. -// To get a complete set of properties, call the DescribeMonitor operation, -// and provide the listed MonitorArn. -type MonitorSummary struct { +type ListExplainabilitiesInput struct { _ struct{} `type:"structure"` - // When the monitor resource was created. - CreationTime *time.Time `type:"timestamp"` - - // The last time the monitor resource was modified. The timestamp depends on - // the status of the job: + // 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. // - // * CREATE_PENDING - The CreationTime. + // Filter properties // - // * CREATE_IN_PROGRESS - The current timestamp. + // * Condition - The condition to apply. Valid values are IS and IS_NOT. // - // * STOPPED - When the resource stopped. + // * Key - The name of the parameter to filter on. Valid values are ResourceArn + // and Status. // - // * ACTIVE or CREATE_FAILED - When the monitor creation finished or failed. - LastModificationTime *time.Time `type:"timestamp"` - - // The Amazon Resource Name (ARN) of the monitor resource. - MonitorArn *string `type:"string"` - - // The name of the monitor resource. - MonitorName *string `min:"1" type:"string"` + // * Value - The value to match. + Filters []*Filter `type:"list"` - // The Amazon Resource Name (ARN) of the predictor being monitored. - ResourceArn *string `type:"string"` + // The number of items returned in the response. + MaxResults *int64 `min:"1" type:"integer"` - // The status of the monitor. States include: - // - // * ACTIVE - // - // * ACTIVE_STOPPING, ACTIVE_STOPPED - // - // * UPDATE_IN_PROGRESS - // - // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - Status *string `type:"string"` + // If the result of the previous request was truncated, the response includes + // a NextToken. To retrieve the next set of results, use the token in the next + // request. Tokens expire after 24 hours. + NextToken *string `min:"1" type:"string"` } // String returns the string representation. @@ -15594,7 +16764,7 @@ type MonitorSummary 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 MonitorSummary) String() string { +func (s ListExplainabilitiesInput) String() string { return awsutil.Prettify(s) } @@ -15603,61 +16773,121 @@ func (s MonitorSummary) 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 MonitorSummary) GoString() string { +func (s ListExplainabilitiesInput) GoString() string { return s.String() } -// SetCreationTime sets the CreationTime field's value. -func (s *MonitorSummary) SetCreationTime(v time.Time) *MonitorSummary { - s.CreationTime = &v - return s -} - -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *MonitorSummary) SetLastModificationTime(v time.Time) *MonitorSummary { - s.LastModificationTime = &v - return s -} - -// SetMonitorArn sets the MonitorArn field's value. -func (s *MonitorSummary) SetMonitorArn(v string) *MonitorSummary { - s.MonitorArn = &v - return s -} - -// SetMonitorName sets the MonitorName field's value. -func (s *MonitorSummary) SetMonitorName(v string) *MonitorSummary { - s.MonitorName = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListExplainabilitiesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListExplainabilitiesInput"} + 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 } -// SetResourceArn sets the ResourceArn field's value. -func (s *MonitorSummary) SetResourceArn(v string) *MonitorSummary { - s.ResourceArn = &v +// SetFilters sets the Filters field's value. +func (s *ListExplainabilitiesInput) SetFilters(v []*Filter) *ListExplainabilitiesInput { + s.Filters = v return s } -// SetStatus sets the Status field's value. -func (s *MonitorSummary) SetStatus(v string) *MonitorSummary { - s.Status = &v +// SetMaxResults sets the MaxResults field's value. +func (s *ListExplainabilitiesInput) SetMaxResults(v int64) *ListExplainabilitiesInput { + s.MaxResults = &v return s } -// Specifies the categorical, continuous, and integer hyperparameters, and their -// ranges of tunable values. The range of tunable values determines which values -// that a hyperparameter tuning job can choose for the specified hyperparameter. -// This object is part of the HyperParameterTuningJobConfig object. -type ParameterRanges struct { +// SetNextToken sets the NextToken field's value. +func (s *ListExplainabilitiesInput) SetNextToken(v string) *ListExplainabilitiesInput { + s.NextToken = &v + return s +} + +type ListExplainabilitiesOutput struct { _ struct{} `type:"structure"` - // Specifies the tunable range for each categorical hyperparameter. - CategoricalParameterRanges []*CategoricalParameterRange `min:"1" type:"list"` + // An array of objects that summarize the properties of each Explainability + // resource. + Explainabilities []*ExplainabilitySummary `type:"list"` - // Specifies the tunable range for each continuous hyperparameter. - ContinuousParameterRanges []*ContinuousParameterRange `min:"1" type:"list"` + // 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"` +} - // Specifies the tunable range for each integer hyperparameter. - IntegerParameterRanges []*IntegerParameterRange `min:"1" 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 ListExplainabilitiesOutput) 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 ListExplainabilitiesOutput) GoString() string { + return s.String() +} + +// 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 *ListExplainabilitiesOutput) SetNextToken(v string) *ListExplainabilitiesOutput { + s.NextToken = &v + return s +} + +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 ResourceArn + // 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"` + + // 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. @@ -15665,7 +16895,7 @@ type ParameterRanges 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 ParameterRanges) String() string { +func (s ListExplainabilityExportsInput) String() string { return awsutil.Prettify(s) } @@ -15674,49 +16904,26 @@ func (s ParameterRanges) 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 ParameterRanges) 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 *ParameterRanges) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ParameterRanges"} - if s.CategoricalParameterRanges != nil && len(s.CategoricalParameterRanges) < 1 { - invalidParams.Add(request.NewErrParamMinLen("CategoricalParameterRanges", 1)) - } - if s.ContinuousParameterRanges != nil && len(s.ContinuousParameterRanges) < 1 { - invalidParams.Add(request.NewErrParamMinLen("ContinuousParameterRanges", 1)) - } - if s.IntegerParameterRanges != nil && len(s.IntegerParameterRanges) < 1 { - invalidParams.Add(request.NewErrParamMinLen("IntegerParameterRanges", 1)) - } - if s.CategoricalParameterRanges != nil { - for i, v := range s.CategoricalParameterRanges { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "CategoricalParameterRanges", i), err.(request.ErrInvalidParams)) - } - } +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.ContinuousParameterRanges != nil { - for i, v := range s.ContinuousParameterRanges { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ContinuousParameterRanges", i), err.(request.ErrInvalidParams)) - } - } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } - if s.IntegerParameterRanges != nil { - for i, v := range s.IntegerParameterRanges { + 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]", "IntegerParameterRanges", i), err.(request.ErrInvalidParams)) + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams)) } } } @@ -15727,72 +16934,34 @@ func (s *ParameterRanges) Validate() error { return nil } -// SetCategoricalParameterRanges sets the CategoricalParameterRanges field's value. -func (s *ParameterRanges) SetCategoricalParameterRanges(v []*CategoricalParameterRange) *ParameterRanges { - s.CategoricalParameterRanges = v +// SetFilters sets the Filters field's value. +func (s *ListExplainabilityExportsInput) SetFilters(v []*Filter) *ListExplainabilityExportsInput { + s.Filters = v return s } -// SetContinuousParameterRanges sets the ContinuousParameterRanges field's value. -func (s *ParameterRanges) SetContinuousParameterRanges(v []*ContinuousParameterRange) *ParameterRanges { - s.ContinuousParameterRanges = v +// SetMaxResults sets the MaxResults field's value. +func (s *ListExplainabilityExportsInput) SetMaxResults(v int64) *ListExplainabilityExportsInput { + s.MaxResults = &v return s } -// SetIntegerParameterRanges sets the IntegerParameterRanges field's value. -func (s *ParameterRanges) SetIntegerParameterRanges(v []*IntegerParameterRange) *ParameterRanges { - s.IntegerParameterRanges = v +// SetNextToken sets the NextToken field's value. +func (s *ListExplainabilityExportsInput) SetNextToken(v string) *ListExplainabilityExportsInput { + s.NextToken = &v return s } -// Provides a summary of the predictor backtest export job properties used in -// the ListPredictorBacktestExportJobs operation. To get a complete set of properties, -// call the DescribePredictorBacktestExportJob operation, and provide the listed -// PredictorBacktestExportJobArn. -type PredictorBacktestExportJobSummary struct { +type ListExplainabilityExportsOutput struct { _ struct{} `type:"structure"` - // When the predictor backtest export job 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 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"` - - // Information about any errors that may have occurred during the backtest export. - Message *string `type:"string"` - - // The Amazon Resource Name (ARN) of the predictor backtest export job. - PredictorBacktestExportJobArn *string `type:"string"` - - // The name of the predictor backtest export job. - PredictorBacktestExportJobName *string `min:"1" type:"string"` + // An array of objects that summarize the properties of each Explainability + // export. + ExplainabilityExports []*ExplainabilityExportSummary `type:"list"` - // The status of the predictor backtest export job. 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"` + // 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"` } // String returns the string representation. @@ -15800,7 +16969,7 @@ type PredictorBacktestExportJobSummary 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 PredictorBacktestExportJobSummary) String() string { +func (s ListExplainabilityExportsOutput) String() string { return awsutil.Prettify(s) } @@ -15809,61 +16978,55 @@ func (s PredictorBacktestExportJobSummary) 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 PredictorBacktestExportJobSummary) GoString() string { +func (s ListExplainabilityExportsOutput) GoString() string { return s.String() } -// SetCreationTime sets the CreationTime field's value. -func (s *PredictorBacktestExportJobSummary) SetCreationTime(v time.Time) *PredictorBacktestExportJobSummary { - s.CreationTime = &v +// SetExplainabilityExports sets the ExplainabilityExports field's value. +func (s *ListExplainabilityExportsOutput) SetExplainabilityExports(v []*ExplainabilityExportSummary) *ListExplainabilityExportsOutput { + s.ExplainabilityExports = v return s } -// SetDestination sets the Destination field's value. -func (s *PredictorBacktestExportJobSummary) SetDestination(v *DataDestination) *PredictorBacktestExportJobSummary { - s.Destination = v +// SetNextToken sets the NextToken field's value. +func (s *ListExplainabilityExportsOutput) SetNextToken(v string) *ListExplainabilityExportsOutput { + s.NextToken = &v return s } -// SetLastModificationTime sets the LastModificationTime field's value. -func (s *PredictorBacktestExportJobSummary) SetLastModificationTime(v time.Time) *PredictorBacktestExportJobSummary { - s.LastModificationTime = &v - return s -} +type ListForecastExportJobsInput struct { + _ struct{} `type:"structure"` -// SetMessage sets the Message field's value. -func (s *PredictorBacktestExportJobSummary) SetMessage(v string) *PredictorBacktestExportJobSummary { - s.Message = &v - return s -} - -// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value. -func (s *PredictorBacktestExportJobSummary) SetPredictorBacktestExportJobArn(v string) *PredictorBacktestExportJobSummary { - s.PredictorBacktestExportJobArn = &v - return s -} - -// SetPredictorBacktestExportJobName sets the PredictorBacktestExportJobName field's value. -func (s *PredictorBacktestExportJobSummary) SetPredictorBacktestExportJobName(v string) *PredictorBacktestExportJobSummary { - s.PredictorBacktestExportJobName = &v - return s -} - -// SetStatus sets the Status field's value. -func (s *PredictorBacktestExportJobSummary) SetStatus(v string) *PredictorBacktestExportJobSummary { - s.Status = &v - return s -} + // 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 + // + // * Condition - The condition to apply. Valid values are IS and IS_NOT. + // To include the forecast export jobs that match the statement, specify + // IS. To exclude matching forecast export jobs, specify IS_NOT. + // + // * Key - The name of the parameter to filter on. Valid values are ForecastArn + // and Status. + // + // * Value - The value to match. + // + // 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::forecast/electricityforecast" + // } ] + Filters []*Filter `type:"list"` -// Metrics you can use as a baseline for comparison purposes. Use these metrics -// when you interpret monitoring results for an auto predictor. -type PredictorBaseline struct { - _ struct{} `type:"structure"` + // The number of items to return in the response. + MaxResults *int64 `min:"1" type:"integer"` - // The initial accuracy metrics (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) - // for the predictor. Use these metrics as a baseline for comparison purposes - // as you use your predictor and the metrics change. - BaselineMetrics []*BaselineMetric `type:"list"` + // 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. @@ -15871,7 +17034,7 @@ type PredictorBaseline 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 PredictorBaseline) String() string { +func (s ListForecastExportJobsInput) String() string { return awsutil.Prettify(s) } @@ -15880,28 +17043,63 @@ func (s PredictorBaseline) 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 PredictorBaseline) GoString() string { +func (s ListForecastExportJobsInput) GoString() string { return s.String() } -// SetBaselineMetrics sets the BaselineMetrics field's value. -func (s *PredictorBaseline) SetBaselineMetrics(v []*BaselineMetric) *PredictorBaseline { - s.BaselineMetrics = v +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListForecastExportJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListForecastExportJobsInput"} + 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 +} + +// SetFilters sets the Filters field's value. +func (s *ListForecastExportJobsInput) SetFilters(v []*Filter) *ListForecastExportJobsInput { + s.Filters = v return s } -// Provides details about a predictor event, such as a retraining. -type PredictorEvent struct { +// SetMaxResults sets the MaxResults field's value. +func (s *ListForecastExportJobsInput) SetMaxResults(v int64) *ListForecastExportJobsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListForecastExportJobsInput) SetNextToken(v string) *ListForecastExportJobsInput { + s.NextToken = &v + return s +} + +type ListForecastExportJobsOutput struct { _ struct{} `type:"structure"` - // The timestamp for when the event occurred. - Datetime *time.Time `type:"timestamp"` + // An array of objects that summarize each export job's properties. + ForecastExportJobs []*ForecastExportJobSummary `type:"list"` - // The type of event. For example, Retrain. A retraining event denotes the timepoint - // when a predictor was retrained. Any monitor results from before the Datetime - // are from the previous predictor. Any new metrics are for the newly retrained - // predictor. - Detail *string `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. @@ -15909,7 +17107,7 @@ type PredictorEvent 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 PredictorEvent) String() string { +func (s ListForecastExportJobsOutput) String() string { return awsutil.Prettify(s) } @@ -15918,32 +17116,55 @@ func (s PredictorEvent) 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 PredictorEvent) GoString() string { +func (s ListForecastExportJobsOutput) GoString() string { return s.String() } -// SetDatetime sets the Datetime field's value. -func (s *PredictorEvent) SetDatetime(v time.Time) *PredictorEvent { - s.Datetime = &v +// SetForecastExportJobs sets the ForecastExportJobs field's value. +func (s *ListForecastExportJobsOutput) SetForecastExportJobs(v []*ForecastExportJobSummary) *ListForecastExportJobsOutput { + s.ForecastExportJobs = v return s } -// SetDetail sets the Detail field's value. -func (s *PredictorEvent) SetDetail(v string) *PredictorEvent { - s.Detail = &v +// SetNextToken sets the NextToken field's value. +func (s *ListForecastExportJobsOutput) SetNextToken(v string) *ListForecastExportJobsOutput { + s.NextToken = &v return s } -// The algorithm used to perform a backtest and the status of those tests. -type PredictorExecution struct { +type ListForecastsInput struct { _ struct{} `type:"structure"` - // The ARN of the algorithm used to test the predictor. - AlgorithmArn *string `type:"string"` + // An array of filters. For each filter, you provide a condition and a match + // statement. The condition is either IS or IS_NOT, which specifies whether + // to include or exclude the forecasts 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 forecasts that match the statement, specify IS. To exclude + // matching forecasts, specify IS_NOT. + // + // * Key - The name of the parameter to filter on. Valid values are DatasetGroupArn, + // PredictorArn, and Status. + // + // * Value - The value to match. + // + // For example, to list all forecasts whose status is not ACTIVE, you would + // specify: + // + // "Filters": [ { "Condition": "IS_NOT", "Key": "Status", "Value": "ACTIVE" + // } ] + Filters []*Filter `type:"list"` - // An array of test windows used to evaluate the algorithm. The NumberOfBacktestWindows - // from the object determines the number of windows in the array. - TestWindows []*TestWindowSummary `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. @@ -15951,7 +17172,7 @@ type PredictorExecution 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 PredictorExecution) String() string { +func (s ListForecastsInput) String() string { return awsutil.Prettify(s) } @@ -15960,33 +17181,63 @@ func (s PredictorExecution) 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 PredictorExecution) GoString() string { +func (s ListForecastsInput) GoString() string { return s.String() } -// SetAlgorithmArn sets the AlgorithmArn field's value. -func (s *PredictorExecution) SetAlgorithmArn(v string) *PredictorExecution { - s.AlgorithmArn = &v +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListForecastsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListForecastsInput"} + 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 +} + +// SetFilters sets the Filters field's value. +func (s *ListForecastsInput) SetFilters(v []*Filter) *ListForecastsInput { + s.Filters = v return s } -// SetTestWindows sets the TestWindows field's value. -func (s *PredictorExecution) SetTestWindows(v []*TestWindowSummary) *PredictorExecution { - s.TestWindows = v +// SetMaxResults sets the MaxResults field's value. +func (s *ListForecastsInput) SetMaxResults(v int64) *ListForecastsInput { + s.MaxResults = &v return s } -// Contains details on the backtests performed to evaluate the accuracy of the -// predictor. The tests are returned in descending order of accuracy, with the -// most accurate backtest appearing first. You specify the number of backtests -// to perform when you call the operation. -type PredictorExecutionDetails struct { +// SetNextToken sets the NextToken field's value. +func (s *ListForecastsInput) SetNextToken(v string) *ListForecastsInput { + s.NextToken = &v + return s +} + +type ListForecastsOutput struct { _ struct{} `type:"structure"` - // An array of the backtests performed to evaluate the accuracy of the predictor - // against a particular algorithm. The NumberOfBacktestWindows from the object - // determines the number of windows in the array. - PredictorExecutions []*PredictorExecution `min:"1" type:"list"` + // An array of objects that summarize each forecast's properties. + Forecasts []*ForecastSummary `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. @@ -15994,7 +17245,7 @@ type PredictorExecutionDetails 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 PredictorExecutionDetails) String() string { +func (s ListForecastsOutput) String() string { return awsutil.Prettify(s) } @@ -16003,56 +17254,57 @@ func (s PredictorExecutionDetails) 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 PredictorExecutionDetails) GoString() string { +func (s ListForecastsOutput) GoString() string { return s.String() } -// SetPredictorExecutions sets the PredictorExecutions field's value. -func (s *PredictorExecutionDetails) SetPredictorExecutions(v []*PredictorExecution) *PredictorExecutionDetails { - s.PredictorExecutions = v +// SetForecasts sets the Forecasts field's value. +func (s *ListForecastsOutput) SetForecasts(v []*ForecastSummary) *ListForecastsOutput { + s.Forecasts = v return s } -// Describes the results of a monitor evaluation. -type PredictorMonitorEvaluation struct { +// SetNextToken sets the NextToken field's value. +func (s *ListForecastsOutput) SetNextToken(v string) *ListForecastsOutput { + s.NextToken = &v + return s +} + +type ListMonitorEvaluationsInput struct { _ struct{} `type:"structure"` - // The status of the monitor evaluation. The state can be SUCCESS or FAILURE. - EvaluationState *string `type:"string"` - - // The timestamp that indicates when the monitor evaluation was started. - EvaluationTime *time.Time `type:"timestamp"` - - // Information about any errors that may have occurred during the monitor evaluation. - Message *string `type:"string"` - - // A list of metrics Forecast calculated when monitoring a predictor. You can - // compare the value for each metric in the list to the metric's value in the - // Baseline to see how your predictor's performance is changing. - MetricResults []*MetricResult `type:"list"` - - // The Amazon Resource Name (ARN) of the monitor resource. - MonitorArn *string `type:"string"` - - // The source of the data the monitor resource used during the evaluation. - MonitorDataSource *MonitorDataSource `type:"structure"` - - // The number of items considered during the evaluation. - NumItemsEvaluated *int64 `type:"long"` - - // Provides details about a predictor event, such as a retraining. - PredictorEvent *PredictorEvent `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 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. + // + // * Key - The name of the parameter to filter on. The only valid value is + // EvaluationState. + // + // * Value - The value to match. Valid values are only SUCCESS or FAILURE. + // + // For example, to list only successful monitor evaluations, you would specify: + // + // "Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" + // } ] + Filters []*Filter `type:"list"` - // The Amazon Resource Name (ARN) of the resource to monitor. - ResourceArn *string `type:"string"` + // The maximum number of monitoring results to return. + MaxResults *int64 `min:"1" type:"integer"` - // The timestamp that indicates the end of the window that is used for monitor - // evaluation. - WindowEndDatetime *time.Time `type:"timestamp"` + // The Amazon Resource Name (ARN) of the monitor resource to get results from. + // + // MonitorArn is a required field + MonitorArn *string `type:"string" required:"true"` - // The timestamp that indicates the start of the window that is used for monitor - // evaluation. - WindowStartDatetime *time.Time `type:"timestamp"` + // 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. @@ -16060,7 +17312,7 @@ type PredictorMonitorEvaluation 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 PredictorMonitorEvaluation) String() string { +func (s ListMonitorEvaluationsInput) String() string { return awsutil.Prettify(s) } @@ -16069,132 +17321,139 @@ func (s PredictorMonitorEvaluation) 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 PredictorMonitorEvaluation) GoString() string { +func (s ListMonitorEvaluationsInput) GoString() string { return s.String() } -// SetEvaluationState sets the EvaluationState field's value. -func (s *PredictorMonitorEvaluation) SetEvaluationState(v string) *PredictorMonitorEvaluation { - s.EvaluationState = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListMonitorEvaluationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListMonitorEvaluationsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.MonitorArn == nil { + invalidParams.Add(request.NewErrParamRequired("MonitorArn")) + } + 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)) + } + } + } -// SetEvaluationTime sets the EvaluationTime field's value. -func (s *PredictorMonitorEvaluation) SetEvaluationTime(v time.Time) *PredictorMonitorEvaluation { - s.EvaluationTime = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetMessage sets the Message field's value. -func (s *PredictorMonitorEvaluation) SetMessage(v string) *PredictorMonitorEvaluation { - s.Message = &v +// SetFilters sets the Filters field's value. +func (s *ListMonitorEvaluationsInput) SetFilters(v []*Filter) *ListMonitorEvaluationsInput { + s.Filters = v return s } -// SetMetricResults sets the MetricResults field's value. -func (s *PredictorMonitorEvaluation) SetMetricResults(v []*MetricResult) *PredictorMonitorEvaluation { - s.MetricResults = v +// SetMaxResults sets the MaxResults field's value. +func (s *ListMonitorEvaluationsInput) SetMaxResults(v int64) *ListMonitorEvaluationsInput { + s.MaxResults = &v return s } // SetMonitorArn sets the MonitorArn field's value. -func (s *PredictorMonitorEvaluation) SetMonitorArn(v string) *PredictorMonitorEvaluation { +func (s *ListMonitorEvaluationsInput) SetMonitorArn(v string) *ListMonitorEvaluationsInput { s.MonitorArn = &v return s } -// SetMonitorDataSource sets the MonitorDataSource field's value. -func (s *PredictorMonitorEvaluation) SetMonitorDataSource(v *MonitorDataSource) *PredictorMonitorEvaluation { - s.MonitorDataSource = v +// SetNextToken sets the NextToken field's value. +func (s *ListMonitorEvaluationsInput) SetNextToken(v string) *ListMonitorEvaluationsInput { + s.NextToken = &v return s } -// SetNumItemsEvaluated sets the NumItemsEvaluated field's value. -func (s *PredictorMonitorEvaluation) SetNumItemsEvaluated(v int64) *PredictorMonitorEvaluation { - s.NumItemsEvaluated = &v - return s +type ListMonitorEvaluationsOutput struct { + _ struct{} `type:"structure"` + + // If the response is truncated, Amazon Forecast returns this token. 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"` + + // The monitoring results and predictor events collected by the monitor resource + // during different windows of time. + // + // For information about monitoring see Viewing Monitoring Results (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html). + // For more information about retrieving monitoring results see Viewing Monitoring + // Results (https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html). + PredictorMonitorEvaluations []*PredictorMonitorEvaluation `type:"list"` } -// SetPredictorEvent sets the PredictorEvent field's value. -func (s *PredictorMonitorEvaluation) SetPredictorEvent(v *PredictorEvent) *PredictorMonitorEvaluation { - s.PredictorEvent = 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 ListMonitorEvaluationsOutput) String() string { + return awsutil.Prettify(s) } -// SetResourceArn sets the ResourceArn field's value. -func (s *PredictorMonitorEvaluation) SetResourceArn(v string) *PredictorMonitorEvaluation { - s.ResourceArn = &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 ListMonitorEvaluationsOutput) GoString() string { + return s.String() } -// SetWindowEndDatetime sets the WindowEndDatetime field's value. -func (s *PredictorMonitorEvaluation) SetWindowEndDatetime(v time.Time) *PredictorMonitorEvaluation { - s.WindowEndDatetime = &v +// SetNextToken sets the NextToken field's value. +func (s *ListMonitorEvaluationsOutput) SetNextToken(v string) *ListMonitorEvaluationsOutput { + s.NextToken = &v return s } -// SetWindowStartDatetime sets the WindowStartDatetime field's value. -func (s *PredictorMonitorEvaluation) SetWindowStartDatetime(v time.Time) *PredictorMonitorEvaluation { - s.WindowStartDatetime = &v +// SetPredictorMonitorEvaluations sets the PredictorMonitorEvaluations field's value. +func (s *ListMonitorEvaluationsOutput) SetPredictorMonitorEvaluations(v []*PredictorMonitorEvaluation) *ListMonitorEvaluationsOutput { + s.PredictorMonitorEvaluations = v return s } -// Provides a summary of the predictor properties that are used in the ListPredictors -// operation. To get the complete set of properties, call the DescribePredictor -// operation, and provide the listed PredictorArn. -type PredictorSummary struct { +type ListMonitorsInput struct { _ struct{} `type:"structure"` - // When the model training task was created. - CreationTime *time.Time `type:"timestamp"` - - // The Amazon Resource Name (ARN) of the dataset group that contains the data - // 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: + // 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. // - // * CREATE_PENDING - The CreationTime. + // Filter properties // - // * CREATE_IN_PROGRESS - The current timestamp. + // * Condition - The condition to apply. Valid values are IS and IS_NOT. // - // * CREATE_STOPPING - The current timestamp. + // * Key - The name of the parameter to filter on. The only valid value is + // Status. // - // * CREATE_STOPPED - When the job stopped. + // * Value - The value to match. // - // * 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 ARN of the predictor. - PredictorArn *string `type:"string"` - - // The name of the predictor. - PredictorName *string `min:"1" type:"string"` + // For example, to list all monitors who's status is ACTIVE, you would specify: + // + // "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ] + Filters []*Filter `type:"list"` - // A summary of the reference predictor used if the predictor was retrained - // or upgraded. - ReferencePredictorSummary *ReferencePredictorSummary `type:"structure"` + // The maximum number of monitors to include in the response. + MaxResults *int64 `min:"1" type:"integer"` - // The status of the predictor. States include: - // - // * ACTIVE - // - // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED - // - // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED - // - // * CREATE_STOPPING, CREATE_STOPPED - // - // The Status of the predictor must be ACTIVE before you can use the predictor - // to create a forecast. - Status *string `type:"string"` + // If the result of the previous request was truncated, the response includes + // a NextToken. To retrieve the next set of results, use the token in the next + // request. Tokens expire after 24 hours. + NextToken *string `min:"1" type:"string"` } // String returns the string representation. @@ -16202,7 +17461,7 @@ type PredictorSummary 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 PredictorSummary) String() string { +func (s ListMonitorsInput) String() string { return awsutil.Prettify(s) } @@ -16211,74 +17470,63 @@ func (s PredictorSummary) 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 PredictorSummary) GoString() string { +func (s ListMonitorsInput) GoString() string { return s.String() } -// SetCreationTime sets the CreationTime field's value. -func (s *PredictorSummary) SetCreationTime(v time.Time) *PredictorSummary { - s.CreationTime = &v - return s -} - -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *PredictorSummary) SetDatasetGroupArn(v string) *PredictorSummary { - s.DatasetGroupArn = &v - 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 - return s -} - -// SetMessage sets the Message field's value. -func (s *PredictorSummary) SetMessage(v string) *PredictorSummary { - s.Message = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListMonitorsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListMonitorsInput"} + 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)) + } + } + } -// SetPredictorArn sets the PredictorArn field's value. -func (s *PredictorSummary) SetPredictorArn(v string) *PredictorSummary { - s.PredictorArn = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetPredictorName sets the PredictorName field's value. -func (s *PredictorSummary) SetPredictorName(v string) *PredictorSummary { - s.PredictorName = &v +// SetFilters sets the Filters field's value. +func (s *ListMonitorsInput) SetFilters(v []*Filter) *ListMonitorsInput { + s.Filters = v return s } -// SetReferencePredictorSummary sets the ReferencePredictorSummary field's value. -func (s *PredictorSummary) SetReferencePredictorSummary(v *ReferencePredictorSummary) *PredictorSummary { - s.ReferencePredictorSummary = v +// SetMaxResults sets the MaxResults field's value. +func (s *ListMonitorsInput) SetMaxResults(v int64) *ListMonitorsInput { + s.MaxResults = &v return s } -// SetStatus sets the Status field's value. -func (s *PredictorSummary) SetStatus(v string) *PredictorSummary { - s.Status = &v +// SetNextToken sets the NextToken field's value. +func (s *ListMonitorsInput) SetNextToken(v string) *ListMonitorsInput { + s.NextToken = &v return s } -// Provides a summary of the reference predictor used when retraining or upgrading -// a predictor. -type ReferencePredictorSummary struct { +type ListMonitorsOutput struct { _ struct{} `type:"structure"` - // The ARN of the reference predictor. - Arn *string `type:"string"` + // An array of objects that summarize each monitor's properties. + Monitors []*MonitorSummary `type:"list"` - // Whether the reference predictor is Active or Deleted. - State *string `type:"string" enum:"State"` + // 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. @@ -16286,7 +17534,7 @@ type ReferencePredictorSummary 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 ReferencePredictorSummary) String() string { +func (s ListMonitorsOutput) String() string { return awsutil.Prettify(s) } @@ -16295,28 +17543,50 @@ func (s ReferencePredictorSummary) 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 ReferencePredictorSummary) GoString() string { +func (s ListMonitorsOutput) GoString() string { return s.String() } -// SetArn sets the Arn field's value. -func (s *ReferencePredictorSummary) SetArn(v string) *ReferencePredictorSummary { - s.Arn = &v +// SetMonitors sets the Monitors field's value. +func (s *ListMonitorsOutput) SetMonitors(v []*MonitorSummary) *ListMonitorsOutput { + s.Monitors = v return s } -// SetState sets the State field's value. -func (s *ReferencePredictorSummary) SetState(v string) *ReferencePredictorSummary { - s.State = &v +// SetNextToken sets the NextToken field's value. +func (s *ListMonitorsOutput) SetNextToken(v string) *ListMonitorsOutput { + s.NextToken = &v return s } -// There is already a resource with this name. Try again with a different name. -type ResourceAlreadyExistsException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +type ListPredictorBacktestExportJobsInput struct { + _ struct{} `type:"structure"` - Message_ *string `locationName:"Message" type:"string"` + // 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 + // + // * Condition - The condition to apply. Valid values are IS and IS_NOT. + // To include the predictor backtest export jobs that match the statement, + // specify IS. To exclude matching predictor backtest export jobs, specify + // 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"` + + // 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. @@ -16324,7 +17594,7 @@ type ResourceAlreadyExistsException 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 ResourceAlreadyExistsException) String() string { +func (s ListPredictorBacktestExportJobsInput) String() string { return awsutil.Prettify(s) } @@ -16333,54 +17603,64 @@ func (s ResourceAlreadyExistsException) 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 ResourceAlreadyExistsException) GoString() string { +func (s ListPredictorBacktestExportJobsInput) GoString() string { return s.String() } -func newErrorResourceAlreadyExistsException(v protocol.ResponseMetadata) error { - return &ResourceAlreadyExistsException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListPredictorBacktestExportJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListPredictorBacktestExportJobsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } -} - -// Code returns the exception type name. -func (s *ResourceAlreadyExistsException) Code() string { - return "ResourceAlreadyExistsException" -} - -// Message returns the exception's message. -func (s *ResourceAlreadyExistsException) Message() string { - if s.Message_ != nil { - return *s.Message_ + 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)) + } + } } - return "" -} -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *ResourceAlreadyExistsException) OrigErr() error { + if invalidParams.Len() > 0 { + return invalidParams + } return nil } -func (s *ResourceAlreadyExistsException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +// SetFilters sets the Filters field's value. +func (s *ListPredictorBacktestExportJobsInput) SetFilters(v []*Filter) *ListPredictorBacktestExportJobsInput { + s.Filters = v + return s } -// Status code returns the HTTP status code for the request's response error. -func (s *ResourceAlreadyExistsException) StatusCode() int { - return s.RespMetadata.StatusCode +// SetMaxResults sets the MaxResults field's value. +func (s *ListPredictorBacktestExportJobsInput) SetMaxResults(v int64) *ListPredictorBacktestExportJobsInput { + s.MaxResults = &v + return s } -// RequestID returns the service's response RequestID for request. -func (s *ResourceAlreadyExistsException) RequestID() string { - return s.RespMetadata.RequestID +// SetNextToken sets the NextToken field's value. +func (s *ListPredictorBacktestExportJobsInput) SetNextToken(v string) *ListPredictorBacktestExportJobsInput { + s.NextToken = &v + return s } -// The specified resource is in use. -type ResourceInUseException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` +type ListPredictorBacktestExportJobsOutput struct { + _ struct{} `type:"structure"` - Message_ *string `locationName:"Message" type:"string"` + // 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"` + + // An array of objects that summarize the properties of each predictor backtest + // export job. + PredictorBacktestExportJobs []*PredictorBacktestExportJobSummary `type:"list"` } // String returns the string representation. @@ -16388,7 +17668,7 @@ type ResourceInUseException 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 ResourceInUseException) String() string { +func (s ListPredictorBacktestExportJobsOutput) String() string { return awsutil.Prettify(s) } @@ -16397,55 +17677,53 @@ func (s ResourceInUseException) 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 ResourceInUseException) GoString() string { +func (s ListPredictorBacktestExportJobsOutput) GoString() string { return s.String() } -func newErrorResourceInUseException(v protocol.ResponseMetadata) error { - return &ResourceInUseException{ - RespMetadata: v, - } -} - -// Code returns the exception type name. -func (s *ResourceInUseException) Code() string { - return "ResourceInUseException" +// SetNextToken sets the NextToken field's value. +func (s *ListPredictorBacktestExportJobsOutput) SetNextToken(v string) *ListPredictorBacktestExportJobsOutput { + s.NextToken = &v + return s } -// Message returns the exception's message. -func (s *ResourceInUseException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" +// SetPredictorBacktestExportJobs sets the PredictorBacktestExportJobs field's value. +func (s *ListPredictorBacktestExportJobsOutput) SetPredictorBacktestExportJobs(v []*PredictorBacktestExportJobSummary) *ListPredictorBacktestExportJobsOutput { + s.PredictorBacktestExportJobs = v + return s } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *ResourceInUseException) OrigErr() error { - return nil -} +type ListPredictorsInput struct { + _ struct{} `type:"structure"` -func (s *ResourceInUseException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) -} + // An array of filters. For each filter, you provide a condition and a match + // statement. The condition is either IS or IS_NOT, which specifies whether + // to include or exclude the predictors that match the statement from the list, + // 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 predictors that match the statement, specify IS. To exclude + // matching predictors, specify IS_NOT. + // + // * Key - The name of the parameter to filter on. Valid values are DatasetGroupArn + // and Status. + // + // * Value - The value to match. + // + // For example, to list all predictors whose status is ACTIVE, you would specify: + // + // "Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ] + Filters []*Filter `type:"list"` -// Status code returns the HTTP status code for the request's response error. -func (s *ResourceInUseException) StatusCode() int { - return s.RespMetadata.StatusCode -} - -// RequestID returns the service's response RequestID for request. -func (s *ResourceInUseException) RequestID() string { - return s.RespMetadata.RequestID -} - -// We can't find a resource with that Amazon Resource Name (ARN). Check the -// ARN and try again. -type ResourceNotFoundException struct { - _ struct{} `type:"structure"` - RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + // The number of items to return in the response. + MaxResults *int64 `min:"1" type:"integer"` - Message_ *string `locationName:"Message" type:"string"` + // If the result of the previous request was truncated, the response includes + // a NextToken. To retrieve the next set of results, use the token in the next + // request. Tokens expire after 24 hours. + NextToken *string `min:"1" type:"string"` } // String returns the string representation. @@ -16453,7 +17731,7 @@ type ResourceNotFoundException 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 ResourceNotFoundException) String() string { +func (s ListPredictorsInput) String() string { return awsutil.Prettify(s) } @@ -16462,52 +17740,100 @@ func (s ResourceNotFoundException) 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 ResourceNotFoundException) GoString() string { +func (s ListPredictorsInput) GoString() string { return s.String() } -func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error { - return &ResourceNotFoundException{ - RespMetadata: v, +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListPredictorsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListPredictorsInput"} + 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 } -// Code returns the exception type name. -func (s *ResourceNotFoundException) Code() string { - return "ResourceNotFoundException" +// SetFilters sets the Filters field's value. +func (s *ListPredictorsInput) SetFilters(v []*Filter) *ListPredictorsInput { + s.Filters = v + return s } -// Message returns the exception's message. -func (s *ResourceNotFoundException) Message() string { - if s.Message_ != nil { - return *s.Message_ - } - return "" +// SetMaxResults sets the MaxResults field's value. +func (s *ListPredictorsInput) SetMaxResults(v int64) *ListPredictorsInput { + s.MaxResults = &v + return s } -// OrigErr always returns nil, satisfies awserr.Error interface. -func (s *ResourceNotFoundException) OrigErr() error { - return nil +// SetNextToken sets the NextToken field's value. +func (s *ListPredictorsInput) SetNextToken(v string) *ListPredictorsInput { + s.NextToken = &v + return s } -func (s *ResourceNotFoundException) Error() string { - return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +type ListPredictorsOutput struct { + _ struct{} `type:"structure"` + + // 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"` + + // An array of objects that summarize each predictor's properties. + Predictors []*PredictorSummary `type:"list"` } -// Status code returns the HTTP status code for the request's response error. -func (s *ResourceNotFoundException) StatusCode() int { - return s.RespMetadata.StatusCode +// 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 ListPredictorsOutput) String() string { + return awsutil.Prettify(s) } -// RequestID returns the service's response RequestID for request. -func (s *ResourceNotFoundException) RequestID() string { - return s.RespMetadata.RequestID +// 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 ListPredictorsOutput) GoString() string { + return s.String() } -type ResumeResourceInput struct { +// SetNextToken sets the NextToken field's value. +func (s *ListPredictorsOutput) SetNextToken(v string) *ListPredictorsOutput { + s.NextToken = &v + return s +} + +// SetPredictors sets the Predictors field's value. +func (s *ListPredictorsOutput) SetPredictors(v []*PredictorSummary) *ListPredictorsOutput { + s.Predictors = v + return s +} + +type ListTagsForResourceInput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) of the monitor resource to resume. + // The Amazon Resource Name (ARN) that identifies the resource for which to + // list the tags. // // ResourceArn is a required field ResourceArn *string `type:"string" required:"true"` @@ -16518,7 +17844,7 @@ type ResumeResourceInput 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 ResumeResourceInput) String() string { +func (s ListTagsForResourceInput) String() string { return awsutil.Prettify(s) } @@ -16527,13 +17853,13 @@ func (s ResumeResourceInput) 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 ResumeResourceInput) GoString() string { +func (s ListTagsForResourceInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *ResumeResourceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "ResumeResourceInput"} +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} if s.ResourceArn == nil { invalidParams.Add(request.NewErrParamRequired("ResourceArn")) } @@ -16545,13 +17871,16 @@ func (s *ResumeResourceInput) Validate() error { } // SetResourceArn sets the ResourceArn field's value. -func (s *ResumeResourceInput) SetResourceArn(v string) *ResumeResourceInput { +func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { s.ResourceArn = &v return s } -type ResumeResourceOutput struct { +type ListTagsForResourceOutput struct { _ struct{} `type:"structure"` + + // The tags for the resource. + Tags []*Tag `type:"list"` } // String returns the string representation. @@ -16559,7 +17888,7 @@ type ResumeResourceOutput 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 ResumeResourceOutput) String() string { +func (s ListTagsForResourceOutput) String() string { return awsutil.Prettify(s) } @@ -16568,36 +17897,50 @@ func (s ResumeResourceOutput) 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 ResumeResourceOutput) GoString() string { +func (s ListTagsForResourceOutput) GoString() string { return s.String() } -// The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, -// and an AWS Identity and Access Management (IAM) role that Amazon Forecast -// can assume to access the file(s). Optionally, includes an AWS Key Management -// Service (KMS) key. This object is part of the DataSource object that is submitted -// in the CreateDatasetImportJob request, and part of the DataDestination object. -type S3Config struct { - _ struct{} `type:"structure"` +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput { + s.Tags = v + return s +} - // The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key. - KMSKeyArn *string `type:"string"` +type ListWhatIfAnalysesInput struct { + _ struct{} `type:"structure"` - // The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) - // in an Amazon S3 bucket. + // 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 what-if analysis jobs that match the statement + // from the list, respectively. The match statement consists of a key and a + // value. // - // Path is a required field - 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 - // a value for the KMSKeyArn key, the role must allow access to the key. + // Filter properties // - // 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. + // * Condition - The condition to apply. Valid values are IS and IS_NOT. + // To include the what-if analysis jobs that match the statement, specify + // IS. To exclude matching what-if analysis jobs, specify IS_NOT. // - // RoleArn is a required field - RoleArn *string `type:"string" required:"true"` + // * Key - The name of the parameter to filter on. Valid values are WhatIfAnalysisArn + // and Status. + // + // * Value - The value to match. + // + // For example, to list all jobs that export a forecast named electricityWhatIf, + // specify the following filter: + // + // "Filters": [ { "Condition": "IS", "Key": "WhatIfAnalysisArn", "Value": "arn:aws:forecast:us-west-2::forecast/electricityWhatIf" + // } ] + 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. @@ -16605,7 +17948,7 @@ type S3Config 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 S3Config) String() string { +func (s ListWhatIfAnalysesInput) String() string { return awsutil.Prettify(s) } @@ -16614,21 +17957,28 @@ func (s S3Config) 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 S3Config) GoString() string { +func (s ListWhatIfAnalysesInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *S3Config) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "S3Config"} - if s.Path == nil { - invalidParams.Add(request.NewErrParamRequired("Path")) +func (s *ListWhatIfAnalysesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListWhatIfAnalysesInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) } - if s.Path != nil && len(*s.Path) < 7 { - invalidParams.Add(request.NewErrParamMinLen("Path", 7)) + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) } - if s.RoleArn == nil { - invalidParams.Add(request.NewErrParamRequired("RoleArn")) + 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 { @@ -16637,30 +17987,33 @@ func (s *S3Config) Validate() error { return nil } -// SetKMSKeyArn sets the KMSKeyArn field's value. -func (s *S3Config) SetKMSKeyArn(v string) *S3Config { - s.KMSKeyArn = &v +// SetFilters sets the Filters field's value. +func (s *ListWhatIfAnalysesInput) SetFilters(v []*Filter) *ListWhatIfAnalysesInput { + s.Filters = v return s } -// SetPath sets the Path field's value. -func (s *S3Config) SetPath(v string) *S3Config { - s.Path = &v +// SetMaxResults sets the MaxResults field's value. +func (s *ListWhatIfAnalysesInput) SetMaxResults(v int64) *ListWhatIfAnalysesInput { + s.MaxResults = &v return s } -// SetRoleArn sets the RoleArn field's value. -func (s *S3Config) SetRoleArn(v string) *S3Config { - s.RoleArn = &v +// SetNextToken sets the NextToken field's value. +func (s *ListWhatIfAnalysesInput) SetNextToken(v string) *ListWhatIfAnalysesInput { + s.NextToken = &v return s } -// Defines the fields of a dataset. -type Schema struct { +type ListWhatIfAnalysesOutput struct { _ struct{} `type:"structure"` - // An array of attributes specifying the name and type of each field in a dataset. - Attributes []*SchemaAttribute `min:"1" type:"list"` + // If the response is truncated, Forecast returns this token. To retrieve the + // next set of results, use the token in the next request. + NextToken *string `min:"1" type:"string"` + + // An array of WhatIfAnalysisSummary objects that describe the matched analyses. + WhatIfAnalyses []*WhatIfAnalysisSummary `type:"list"` } // String returns the string representation. @@ -16668,7 +18021,7 @@ type Schema 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 Schema) String() string { +func (s ListWhatIfAnalysesOutput) String() string { return awsutil.Prettify(s) } @@ -16677,53 +18030,56 @@ func (s Schema) 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 Schema) GoString() string { +func (s ListWhatIfAnalysesOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *Schema) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "Schema"} - if s.Attributes != nil && len(s.Attributes) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Attributes", 1)) - } - if s.Attributes != nil { - for i, v := range s.Attributes { - if v == nil { - continue - } - if err := v.Validate(); err != nil { - invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Attributes", i), err.(request.ErrInvalidParams)) - } - } - } +// SetNextToken sets the NextToken field's value. +func (s *ListWhatIfAnalysesOutput) SetNextToken(v string) *ListWhatIfAnalysesOutput { + s.NextToken = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil -} - -// SetAttributes sets the Attributes field's value. -func (s *Schema) SetAttributes(v []*SchemaAttribute) *Schema { - s.Attributes = v +// SetWhatIfAnalyses sets the WhatIfAnalyses field's value. +func (s *ListWhatIfAnalysesOutput) SetWhatIfAnalyses(v []*WhatIfAnalysisSummary) *ListWhatIfAnalysesOutput { + s.WhatIfAnalyses = v return s } -// An attribute of a schema, which defines a dataset field. A schema attribute -// is required for every field in a dataset. The Schema (https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html) -// object contains an array of SchemaAttribute objects. -type SchemaAttribute struct { +type ListWhatIfForecastExportsInput struct { _ struct{} `type:"structure"` - // The name of the dataset field. - AttributeName *string `min:"1" type:"string"` - - // The data type of the field. + // 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 what-if forecast export jobs that match the statement + // from the list, respectively. The match statement consists of a key and a + // value. // - // For a related time series dataset, other than date, item_id, and forecast - // dimensions attributes, all attributes should be of numerical type (integer/float). - AttributeType *string `type:"string" enum:"AttributeType"` + // Filter properties + // + // * Condition - The condition to apply. Valid values are IS and IS_NOT. + // To include the forecast export jobs that match the statement, specify + // IS. To exclude matching forecast export jobs, specify IS_NOT. + // + // * Key - The name of the parameter to filter on. Valid values are WhatIfForecastExportArn + // and Status. + // + // * Value - The value to match. + // + // For example, to list all jobs that export a forecast named electricityWIFExport, + // specify the following filter: + // + // "Filters": [ { "Condition": "IS", "Key": "WhatIfForecastExportArn", "Value": + // "arn:aws:forecast:us-west-2::forecast/electricityWIFExport" } ] + 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. @@ -16731,7 +18087,7 @@ type SchemaAttribute 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 SchemaAttribute) String() string { +func (s ListWhatIfForecastExportsInput) String() string { return awsutil.Prettify(s) } @@ -16740,15 +18096,28 @@ func (s SchemaAttribute) 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 SchemaAttribute) GoString() string { +func (s ListWhatIfForecastExportsInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *SchemaAttribute) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "SchemaAttribute"} - if s.AttributeName != nil && len(*s.AttributeName) < 1 { - invalidParams.Add(request.NewErrParamMinLen("AttributeName", 1)) +func (s *ListWhatIfForecastExportsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListWhatIfForecastExportsInput"} + 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 { @@ -16757,67 +18126,34 @@ func (s *SchemaAttribute) Validate() error { return nil } -// SetAttributeName sets the AttributeName field's value. -func (s *SchemaAttribute) SetAttributeName(v string) *SchemaAttribute { - s.AttributeName = &v +// SetFilters sets the Filters field's value. +func (s *ListWhatIfForecastExportsInput) SetFilters(v []*Filter) *ListWhatIfForecastExportsInput { + s.Filters = v return s } -// SetAttributeType sets the AttributeType field's value. -func (s *SchemaAttribute) SetAttributeType(v string) *SchemaAttribute { - s.AttributeType = &v +// SetMaxResults sets the MaxResults field's value. +func (s *ListWhatIfForecastExportsInput) SetMaxResults(v int64) *ListWhatIfForecastExportsInput { + s.MaxResults = &v return s } -// Provides statistics for each data field imported into to an Amazon Forecast -// dataset with the CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) -// operation. -type Statistics struct { - _ struct{} `type:"structure"` - - // For a numeric field, the average value in the field. - Avg *float64 `type:"double"` - - // The number of values in the field. If the response value is -1, refer to - // CountLong. - Count *int64 `type:"integer"` - - // The number of distinct values in the field. If the response value is -1, - // refer to CountDistinctLong. - CountDistinct *int64 `type:"integer"` - - // The number of distinct values in the field. CountDistinctLong is used instead - // of CountDistinct if the value is greater than 2,147,483,647. - CountDistinctLong *int64 `type:"long"` - - // The number of values in the field. CountLong is used instead of Count if - // the value is greater than 2,147,483,647. - CountLong *int64 `type:"long"` - - // The number of NAN (not a number) values in the field. If the response value - // is -1, refer to CountNanLong. - CountNan *int64 `type:"integer"` - - // The number of NAN (not a number) values in the field. CountNanLong is used - // instead of CountNan if the value is greater than 2,147,483,647. - CountNanLong *int64 `type:"long"` - - // The number of null values in the field. If the response value is -1, refer - // to CountNullLong. - CountNull *int64 `type:"integer"` - - // The number of null values in the field. CountNullLong is used instead of - // CountNull if the value is greater than 2,147,483,647. - CountNullLong *int64 `type:"long"` +// SetNextToken sets the NextToken field's value. +func (s *ListWhatIfForecastExportsInput) SetNextToken(v string) *ListWhatIfForecastExportsInput { + s.NextToken = &v + return s +} - // For a numeric field, the maximum value in the field. - Max *string `type:"string"` +type ListWhatIfForecastExportsOutput struct { + _ struct{} `type:"structure"` - // For a numeric field, the minimum value in the field. - Min *string `type:"string"` + // If the response is truncated, Forecast returns this token. To retrieve the + // next set of results, use the token in the next request. + NextToken *string `min:"1" type:"string"` - // For a numeric field, the standard deviation. - Stddev *float64 `type:"double"` + // An array of WhatIfForecastExports objects that describe the matched forecast + // exports. + WhatIfForecastExports []*WhatIfForecastExportSummary `type:"list"` } // String returns the string representation. @@ -16825,7 +18161,7 @@ type Statistics 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 Statistics) String() string { +func (s ListWhatIfForecastExportsOutput) String() string { return awsutil.Prettify(s) } @@ -16834,91 +18170,130 @@ func (s Statistics) 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 Statistics) GoString() string { +func (s ListWhatIfForecastExportsOutput) GoString() string { return s.String() } -// SetAvg sets the Avg field's value. -func (s *Statistics) SetAvg(v float64) *Statistics { - s.Avg = &v +// SetNextToken sets the NextToken field's value. +func (s *ListWhatIfForecastExportsOutput) SetNextToken(v string) *ListWhatIfForecastExportsOutput { + s.NextToken = &v return s } -// SetCount sets the Count field's value. -func (s *Statistics) SetCount(v int64) *Statistics { - s.Count = &v +// SetWhatIfForecastExports sets the WhatIfForecastExports field's value. +func (s *ListWhatIfForecastExportsOutput) SetWhatIfForecastExports(v []*WhatIfForecastExportSummary) *ListWhatIfForecastExportsOutput { + s.WhatIfForecastExports = v return s } -// SetCountDistinct sets the CountDistinct field's value. -func (s *Statistics) SetCountDistinct(v int64) *Statistics { - s.CountDistinct = &v - return s -} +type ListWhatIfForecastsInput struct { + _ struct{} `type:"structure"` -// SetCountDistinctLong sets the CountDistinctLong field's value. -func (s *Statistics) SetCountDistinctLong(v int64) *Statistics { - s.CountDistinctLong = &v - return s -} + // 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 what-if forecast export jobs 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 forecast export jobs that match the statement, specify + // IS. To exclude matching forecast export jobs, specify IS_NOT. + // + // * Key - The name of the parameter to filter on. Valid values are WhatIfForecastArn + // and Status. + // + // * Value - The value to match. + // + // For example, to list all jobs that export a forecast named electricityWhatIfForecast, + // specify the following filter: + // + // "Filters": [ { "Condition": "IS", "Key": "WhatIfForecastArn", "Value": "arn:aws:forecast:us-west-2::forecast/electricityWhatIfForecast" + // } ] + Filters []*Filter `type:"list"` -// SetCountLong sets the CountLong field's value. -func (s *Statistics) SetCountLong(v int64) *Statistics { - s.CountLong = &v - return s -} + // The number of items to return in the response. + MaxResults *int64 `min:"1" type:"integer"` -// SetCountNan sets the CountNan field's value. -func (s *Statistics) SetCountNan(v int64) *Statistics { - s.CountNan = &v - return s + // 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"` } -// SetCountNanLong sets the CountNanLong field's value. -func (s *Statistics) SetCountNanLong(v int64) *Statistics { - s.CountNanLong = &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 ListWhatIfForecastsInput) String() string { + return awsutil.Prettify(s) } -// SetCountNull sets the CountNull field's value. -func (s *Statistics) SetCountNull(v int64) *Statistics { - s.CountNull = &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 ListWhatIfForecastsInput) GoString() string { + return s.String() } -// SetCountNullLong sets the CountNullLong field's value. -func (s *Statistics) SetCountNullLong(v int64) *Statistics { - s.CountNullLong = &v - return s +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListWhatIfForecastsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListWhatIfForecastsInput"} + 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 } -// SetMax sets the Max field's value. -func (s *Statistics) SetMax(v string) *Statistics { - s.Max = &v +// SetFilters sets the Filters field's value. +func (s *ListWhatIfForecastsInput) SetFilters(v []*Filter) *ListWhatIfForecastsInput { + s.Filters = v return s } -// SetMin sets the Min field's value. -func (s *Statistics) SetMin(v string) *Statistics { - s.Min = &v +// SetMaxResults sets the MaxResults field's value. +func (s *ListWhatIfForecastsInput) SetMaxResults(v int64) *ListWhatIfForecastsInput { + s.MaxResults = &v return s } -// SetStddev sets the Stddev field's value. -func (s *Statistics) SetStddev(v float64) *Statistics { - s.Stddev = &v +// SetNextToken sets the NextToken field's value. +func (s *ListWhatIfForecastsInput) SetNextToken(v string) *ListWhatIfForecastsInput { + s.NextToken = &v return s } -type StopResourceInput struct { +type ListWhatIfForecastsOutput struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that identifies the resource to stop. The - // supported ARNs are DatasetImportJobArn, PredictorArn, PredictorBacktestExportJobArn, - // ForecastArn, ForecastExportJobArn, ExplainabilityArn, and ExplainabilityExportArn. - // - // ResourceArn is a required field - ResourceArn *string `type:"string" required:"true"` + // 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"` + + // An array of WhatIfForecasts objects that describe the matched forecasts. + WhatIfForecasts []*WhatIfForecastSummary `type:"list"` } // String returns the string representation. @@ -16926,7 +18301,7 @@ type StopResourceInput 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 StopResourceInput) String() string { +func (s ListWhatIfForecastsOutput) String() string { return awsutil.Prettify(s) } @@ -16935,31 +18310,36 @@ func (s StopResourceInput) 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 StopResourceInput) GoString() string { +func (s ListWhatIfForecastsOutput) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *StopResourceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "StopResourceInput"} - if s.ResourceArn == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceArn")) - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetNextToken sets the NextToken field's value. +func (s *ListWhatIfForecastsOutput) SetNextToken(v string) *ListWhatIfForecastsOutput { + s.NextToken = &v + return s } -// SetResourceArn sets the ResourceArn field's value. -func (s *StopResourceInput) SetResourceArn(v string) *StopResourceInput { - s.ResourceArn = &v +// SetWhatIfForecasts sets the WhatIfForecasts field's value. +func (s *ListWhatIfForecastsOutput) SetWhatIfForecasts(v []*WhatIfForecastSummary) *ListWhatIfForecastsOutput { + s.WhatIfForecasts = v return s } -type StopResourceOutput struct { +// An individual metric Forecast calculated when monitoring predictor usage. +// You can compare the value for this metric to the metric's value in the Baseline +// to see how your predictor's performance is changing. +// +// For more information about metrics generated by Forecast see Evaluating Predictor +// Accuracy (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) +type MetricResult struct { _ struct{} `type:"structure"` + + // The name of the metric. + MetricName *string `type:"string"` + + // The value for the metric. + MetricValue *float64 `type:"double"` } // String returns the string representation. @@ -16967,7 +18347,7 @@ type StopResourceOutput 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 StopResourceOutput) String() string { +func (s MetricResult) String() string { return awsutil.Prettify(s) } @@ -16976,183 +18356,44 @@ func (s StopResourceOutput) 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 StopResourceOutput) GoString() string { +func (s MetricResult) GoString() string { return s.String() } -// This object belongs to the CreatePredictor operation. If you created your -// predictor with CreateAutoPredictor, see AdditionalDataset. -// -// Describes a supplementary feature of a dataset group. This object is part -// of the InputDataConfig object. Forecast supports the Weather Index and Holidays -// built-in featurizations. -// -// # Weather Index -// -// The Amazon Forecast Weather Index is a built-in featurization 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 featurization that incorporates a feature-engineered -// dataset of 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 SupplementaryFeature struct { +// SetMetricName sets the MetricName field's value. +func (s *MetricResult) SetMetricName(v string) *MetricResult { + s.MetricName = &v + return s +} + +// SetMetricValue sets the MetricValue field's value. +func (s *MetricResult) SetMetricValue(v float64) *MetricResult { + s.MetricValue = &v + return s +} + +// Provides metrics that are used to evaluate the performance of a predictor. +// This object is part of the WindowSummary object. +type Metrics struct { _ struct{} `type:"structure"` - // The name of the feature. Valid values: "holiday" and "weather". - // - // Name is a required field - Name *string `min:"1" type:"string" required:"true"` + // The average value of all weighted quantile losses. + AverageWeightedQuantileLoss *float64 `type:"double"` - // 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: - // - // * "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 + // Provides detailed error metrics for each forecast type. Metrics include root-mean + // square-error (RMSE), mean absolute percentage error (MAPE), mean absolute + // scaled error (MASE), and weighted average percentage error (WAPE). + ErrorMetrics []*ErrorMetric `type:"list"` + + // The root-mean-square error (RMSE). // - // Value is a required field - Value *string `type:"string" required:"true"` + // Deprecated: This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPE + RMSE *float64 `deprecated:"true" type:"double"` + + // An array of weighted quantile losses. Quantiles divide a probability distribution + // into regions of equal probability. The distribution in this case is the loss + // function. + WeightedQuantileLosses []*WeightedQuantileLoss `type:"list"` } // String returns the string representation. @@ -17160,7 +18401,7 @@ type SupplementaryFeature 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 SupplementaryFeature) String() string { +func (s Metrics) String() string { return awsutil.Prettify(s) } @@ -17169,92 +18410,2314 @@ func (s SupplementaryFeature) 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 SupplementaryFeature) GoString() string { +func (s Metrics) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *SupplementaryFeature) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "SupplementaryFeature"} - 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.Value == nil { - invalidParams.Add(request.NewErrParamRequired("Value")) - } +// SetAverageWeightedQuantileLoss sets the AverageWeightedQuantileLoss field's value. +func (s *Metrics) SetAverageWeightedQuantileLoss(v float64) *Metrics { + s.AverageWeightedQuantileLoss = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } +// SetErrorMetrics sets the ErrorMetrics field's value. +func (s *Metrics) SetErrorMetrics(v []*ErrorMetric) *Metrics { + s.ErrorMetrics = v + return s +} + +// SetRMSE sets the RMSE field's value. +func (s *Metrics) SetRMSE(v float64) *Metrics { + s.RMSE = &v + return s +} + +// SetWeightedQuantileLosses sets the WeightedQuantileLosses field's value. +func (s *Metrics) SetWeightedQuantileLosses(v []*WeightedQuantileLoss) *Metrics { + s.WeightedQuantileLosses = v + return s +} + +// The configuration details for the predictor monitor. +type MonitorConfig struct { + _ struct{} `type:"structure"` + + // The name of the monitor resource. + // + // MonitorName is a required field + MonitorName *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 MonitorConfig) 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 MonitorConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *MonitorConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "MonitorConfig"} + if s.MonitorName == nil { + invalidParams.Add(request.NewErrParamRequired("MonitorName")) + } + if s.MonitorName != nil && len(*s.MonitorName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("MonitorName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMonitorName sets the MonitorName field's value. +func (s *MonitorConfig) SetMonitorName(v string) *MonitorConfig { + s.MonitorName = &v + return s +} + +// The source of the data the monitor used during the evaluation. +type MonitorDataSource struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the dataset import job used to import the + // data that initiated the monitor evaluation. + DatasetImportJobArn *string `type:"string"` + + // The Amazon Resource Name (ARN) of the forecast the monitor used during the + // evaluation. + ForecastArn *string `type:"string"` + + // The Amazon Resource Name (ARN) of the predictor resource you are monitoring. + 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 MonitorDataSource) 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 MonitorDataSource) GoString() string { + return s.String() +} + +// SetDatasetImportJobArn sets the DatasetImportJobArn field's value. +func (s *MonitorDataSource) SetDatasetImportJobArn(v string) *MonitorDataSource { + s.DatasetImportJobArn = &v + return s +} + +// SetForecastArn sets the ForecastArn field's value. +func (s *MonitorDataSource) SetForecastArn(v string) *MonitorDataSource { + s.ForecastArn = &v + return s +} + +// SetPredictorArn sets the PredictorArn field's value. +func (s *MonitorDataSource) SetPredictorArn(v string) *MonitorDataSource { + s.PredictorArn = &v + return s +} + +// Provides information about the monitor resource. +type MonitorInfo struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the monitor resource. + MonitorArn *string `type:"string"` + + // The status of the monitor. States include: + // + // * ACTIVE + // + // * ACTIVE_STOPPING, ACTIVE_STOPPED + // + // * UPDATE_IN_PROGRESS + // + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + 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 MonitorInfo) 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 MonitorInfo) GoString() string { + return s.String() +} + +// SetMonitorArn sets the MonitorArn field's value. +func (s *MonitorInfo) SetMonitorArn(v string) *MonitorInfo { + s.MonitorArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *MonitorInfo) SetStatus(v string) *MonitorInfo { + s.Status = &v + return s +} + +// Provides a summary of the monitor properties used in the ListMonitors operation. +// To get a complete set of properties, call the DescribeMonitor operation, +// and provide the listed MonitorArn. +type MonitorSummary struct { + _ struct{} `type:"structure"` + + // When the monitor resource was created. + CreationTime *time.Time `type:"timestamp"` + + // The last time the monitor resource was modified. The timestamp depends on + // the status of the job: + // + // * CREATE_PENDING - The CreationTime. + // + // * CREATE_IN_PROGRESS - The current timestamp. + // + // * STOPPED - When the resource stopped. + // + // * ACTIVE or CREATE_FAILED - When the monitor creation finished or failed. + LastModificationTime *time.Time `type:"timestamp"` + + // The Amazon Resource Name (ARN) of the monitor resource. + MonitorArn *string `type:"string"` + + // The name of the monitor resource. + MonitorName *string `min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of the predictor being monitored. + ResourceArn *string `type:"string"` + + // The status of the monitor. States include: + // + // * ACTIVE + // + // * ACTIVE_STOPPING, ACTIVE_STOPPED + // + // * UPDATE_IN_PROGRESS + // + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + 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 MonitorSummary) 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 MonitorSummary) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *MonitorSummary) SetCreationTime(v time.Time) *MonitorSummary { + s.CreationTime = &v + return s +} + +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *MonitorSummary) SetLastModificationTime(v time.Time) *MonitorSummary { + s.LastModificationTime = &v + return s +} + +// SetMonitorArn sets the MonitorArn field's value. +func (s *MonitorSummary) SetMonitorArn(v string) *MonitorSummary { + s.MonitorArn = &v + return s +} + +// SetMonitorName sets the MonitorName field's value. +func (s *MonitorSummary) SetMonitorName(v string) *MonitorSummary { + s.MonitorName = &v + return s +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *MonitorSummary) SetResourceArn(v string) *MonitorSummary { + s.ResourceArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *MonitorSummary) SetStatus(v string) *MonitorSummary { + s.Status = &v + return s +} + +// Specifies the categorical, continuous, and integer hyperparameters, and their +// ranges of tunable values. The range of tunable values determines which values +// that a hyperparameter tuning job can choose for the specified hyperparameter. +// This object is part of the HyperParameterTuningJobConfig object. +type ParameterRanges struct { + _ struct{} `type:"structure"` + + // Specifies the tunable range for each categorical hyperparameter. + CategoricalParameterRanges []*CategoricalParameterRange `min:"1" type:"list"` + + // Specifies the tunable range for each continuous hyperparameter. + ContinuousParameterRanges []*ContinuousParameterRange `min:"1" type:"list"` + + // Specifies the tunable range for each integer hyperparameter. + IntegerParameterRanges []*IntegerParameterRange `min:"1" 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 ParameterRanges) 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 ParameterRanges) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ParameterRanges) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ParameterRanges"} + if s.CategoricalParameterRanges != nil && len(s.CategoricalParameterRanges) < 1 { + invalidParams.Add(request.NewErrParamMinLen("CategoricalParameterRanges", 1)) + } + if s.ContinuousParameterRanges != nil && len(s.ContinuousParameterRanges) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ContinuousParameterRanges", 1)) + } + if s.IntegerParameterRanges != nil && len(s.IntegerParameterRanges) < 1 { + invalidParams.Add(request.NewErrParamMinLen("IntegerParameterRanges", 1)) + } + if s.CategoricalParameterRanges != nil { + for i, v := range s.CategoricalParameterRanges { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "CategoricalParameterRanges", i), err.(request.ErrInvalidParams)) + } + } + } + if s.ContinuousParameterRanges != nil { + for i, v := range s.ContinuousParameterRanges { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "ContinuousParameterRanges", i), err.(request.ErrInvalidParams)) + } + } + } + if s.IntegerParameterRanges != nil { + for i, v := range s.IntegerParameterRanges { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "IntegerParameterRanges", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetCategoricalParameterRanges sets the CategoricalParameterRanges field's value. +func (s *ParameterRanges) SetCategoricalParameterRanges(v []*CategoricalParameterRange) *ParameterRanges { + s.CategoricalParameterRanges = v + return s +} + +// SetContinuousParameterRanges sets the ContinuousParameterRanges field's value. +func (s *ParameterRanges) SetContinuousParameterRanges(v []*ContinuousParameterRange) *ParameterRanges { + s.ContinuousParameterRanges = v + return s +} + +// SetIntegerParameterRanges sets the IntegerParameterRanges field's value. +func (s *ParameterRanges) SetIntegerParameterRanges(v []*IntegerParameterRange) *ParameterRanges { + s.IntegerParameterRanges = v + return s +} + +// Provides a summary of the predictor backtest export job properties used in +// the ListPredictorBacktestExportJobs operation. To get a complete set of properties, +// call the DescribePredictorBacktestExportJob operation, and provide the listed +// PredictorBacktestExportJobArn. +type PredictorBacktestExportJobSummary struct { + _ struct{} `type:"structure"` + + // When the predictor backtest export job 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 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"` + + // Information about any errors that may have occurred during the backtest export. + Message *string `type:"string"` + + // The Amazon Resource Name (ARN) of the predictor backtest export job. + PredictorBacktestExportJobArn *string `type:"string"` + + // The name of the predictor backtest export job. + PredictorBacktestExportJobName *string `min:"1" type:"string"` + + // The status of the predictor backtest export job. 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. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s PredictorBacktestExportJobSummary) 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 PredictorBacktestExportJobSummary) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *PredictorBacktestExportJobSummary) SetCreationTime(v time.Time) *PredictorBacktestExportJobSummary { + s.CreationTime = &v + return s +} + +// SetDestination sets the Destination field's value. +func (s *PredictorBacktestExportJobSummary) SetDestination(v *DataDestination) *PredictorBacktestExportJobSummary { + s.Destination = v + return s +} + +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *PredictorBacktestExportJobSummary) SetLastModificationTime(v time.Time) *PredictorBacktestExportJobSummary { + s.LastModificationTime = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *PredictorBacktestExportJobSummary) SetMessage(v string) *PredictorBacktestExportJobSummary { + s.Message = &v + return s +} + +// SetPredictorBacktestExportJobArn sets the PredictorBacktestExportJobArn field's value. +func (s *PredictorBacktestExportJobSummary) SetPredictorBacktestExportJobArn(v string) *PredictorBacktestExportJobSummary { + s.PredictorBacktestExportJobArn = &v + return s +} + +// SetPredictorBacktestExportJobName sets the PredictorBacktestExportJobName field's value. +func (s *PredictorBacktestExportJobSummary) SetPredictorBacktestExportJobName(v string) *PredictorBacktestExportJobSummary { + s.PredictorBacktestExportJobName = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *PredictorBacktestExportJobSummary) SetStatus(v string) *PredictorBacktestExportJobSummary { + s.Status = &v + return s +} + +// Metrics you can use as a baseline for comparison purposes. Use these metrics +// when you interpret monitoring results for an auto predictor. +type PredictorBaseline struct { + _ struct{} `type:"structure"` + + // The initial accuracy metrics (https://docs.aws.amazon.com/forecast/latest/dg/metrics.html) + // for the predictor. Use these metrics as a baseline for comparison purposes + // as you use your predictor and the metrics change. + BaselineMetrics []*BaselineMetric `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 PredictorBaseline) 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 PredictorBaseline) GoString() string { + return s.String() +} + +// SetBaselineMetrics sets the BaselineMetrics field's value. +func (s *PredictorBaseline) SetBaselineMetrics(v []*BaselineMetric) *PredictorBaseline { + s.BaselineMetrics = v + return s +} + +// Provides details about a predictor event, such as a retraining. +type PredictorEvent struct { + _ struct{} `type:"structure"` + + // The timestamp for when the event occurred. + Datetime *time.Time `type:"timestamp"` + + // The type of event. For example, Retrain. A retraining event denotes the timepoint + // when a predictor was retrained. Any monitor results from before the Datetime + // are from the previous predictor. Any new metrics are for the newly retrained + // predictor. + Detail *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 PredictorEvent) 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 PredictorEvent) GoString() string { + return s.String() +} + +// SetDatetime sets the Datetime field's value. +func (s *PredictorEvent) SetDatetime(v time.Time) *PredictorEvent { + s.Datetime = &v + return s +} + +// SetDetail sets the Detail field's value. +func (s *PredictorEvent) SetDetail(v string) *PredictorEvent { + s.Detail = &v + return s +} + +// The algorithm used to perform a backtest and the status of those tests. +type PredictorExecution struct { + _ struct{} `type:"structure"` + + // The ARN of the algorithm used to test the predictor. + AlgorithmArn *string `type:"string"` + + // An array of test windows used to evaluate the algorithm. The NumberOfBacktestWindows + // from the object determines the number of windows in the array. + TestWindows []*TestWindowSummary `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 PredictorExecution) 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 PredictorExecution) GoString() string { + return s.String() +} + +// SetAlgorithmArn sets the AlgorithmArn field's value. +func (s *PredictorExecution) SetAlgorithmArn(v string) *PredictorExecution { + s.AlgorithmArn = &v + return s +} + +// SetTestWindows sets the TestWindows field's value. +func (s *PredictorExecution) SetTestWindows(v []*TestWindowSummary) *PredictorExecution { + s.TestWindows = v + return s +} + +// Contains details on the backtests performed to evaluate the accuracy of the +// predictor. The tests are returned in descending order of accuracy, with the +// most accurate backtest appearing first. You specify the number of backtests +// to perform when you call the operation. +type PredictorExecutionDetails struct { + _ struct{} `type:"structure"` + + // An array of the backtests performed to evaluate the accuracy of the predictor + // against a particular algorithm. The NumberOfBacktestWindows from the object + // determines the number of windows in the array. + PredictorExecutions []*PredictorExecution `min:"1" 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 PredictorExecutionDetails) 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 PredictorExecutionDetails) GoString() string { + return s.String() +} + +// SetPredictorExecutions sets the PredictorExecutions field's value. +func (s *PredictorExecutionDetails) SetPredictorExecutions(v []*PredictorExecution) *PredictorExecutionDetails { + s.PredictorExecutions = v + return s +} + +// Describes the results of a monitor evaluation. +type PredictorMonitorEvaluation struct { + _ struct{} `type:"structure"` + + // The status of the monitor evaluation. The state can be SUCCESS or FAILURE. + EvaluationState *string `type:"string"` + + // The timestamp that indicates when the monitor evaluation was started. + EvaluationTime *time.Time `type:"timestamp"` + + // Information about any errors that may have occurred during the monitor evaluation. + Message *string `type:"string"` + + // A list of metrics Forecast calculated when monitoring a predictor. You can + // compare the value for each metric in the list to the metric's value in the + // Baseline to see how your predictor's performance is changing. + MetricResults []*MetricResult `type:"list"` + + // The Amazon Resource Name (ARN) of the monitor resource. + MonitorArn *string `type:"string"` + + // The source of the data the monitor resource used during the evaluation. + MonitorDataSource *MonitorDataSource `type:"structure"` + + // The number of items considered during the evaluation. + NumItemsEvaluated *int64 `type:"long"` + + // Provides details about a predictor event, such as a retraining. + PredictorEvent *PredictorEvent `type:"structure"` + + // The Amazon Resource Name (ARN) of the resource to monitor. + ResourceArn *string `type:"string"` + + // The timestamp that indicates the end of the window that is used for monitor + // evaluation. + WindowEndDatetime *time.Time `type:"timestamp"` + + // The timestamp that indicates the start of the window that is used for monitor + // evaluation. + WindowStartDatetime *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 PredictorMonitorEvaluation) 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 PredictorMonitorEvaluation) GoString() string { + return s.String() +} + +// SetEvaluationState sets the EvaluationState field's value. +func (s *PredictorMonitorEvaluation) SetEvaluationState(v string) *PredictorMonitorEvaluation { + s.EvaluationState = &v + return s +} + +// SetEvaluationTime sets the EvaluationTime field's value. +func (s *PredictorMonitorEvaluation) SetEvaluationTime(v time.Time) *PredictorMonitorEvaluation { + s.EvaluationTime = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *PredictorMonitorEvaluation) SetMessage(v string) *PredictorMonitorEvaluation { + s.Message = &v + return s +} + +// SetMetricResults sets the MetricResults field's value. +func (s *PredictorMonitorEvaluation) SetMetricResults(v []*MetricResult) *PredictorMonitorEvaluation { + s.MetricResults = v + return s +} + +// SetMonitorArn sets the MonitorArn field's value. +func (s *PredictorMonitorEvaluation) SetMonitorArn(v string) *PredictorMonitorEvaluation { + s.MonitorArn = &v + return s +} + +// SetMonitorDataSource sets the MonitorDataSource field's value. +func (s *PredictorMonitorEvaluation) SetMonitorDataSource(v *MonitorDataSource) *PredictorMonitorEvaluation { + s.MonitorDataSource = v + return s +} + +// SetNumItemsEvaluated sets the NumItemsEvaluated field's value. +func (s *PredictorMonitorEvaluation) SetNumItemsEvaluated(v int64) *PredictorMonitorEvaluation { + s.NumItemsEvaluated = &v + return s +} + +// SetPredictorEvent sets the PredictorEvent field's value. +func (s *PredictorMonitorEvaluation) SetPredictorEvent(v *PredictorEvent) *PredictorMonitorEvaluation { + s.PredictorEvent = v + return s +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *PredictorMonitorEvaluation) SetResourceArn(v string) *PredictorMonitorEvaluation { + s.ResourceArn = &v + return s +} + +// SetWindowEndDatetime sets the WindowEndDatetime field's value. +func (s *PredictorMonitorEvaluation) SetWindowEndDatetime(v time.Time) *PredictorMonitorEvaluation { + s.WindowEndDatetime = &v + return s +} + +// SetWindowStartDatetime sets the WindowStartDatetime field's value. +func (s *PredictorMonitorEvaluation) SetWindowStartDatetime(v time.Time) *PredictorMonitorEvaluation { + s.WindowStartDatetime = &v + return s +} + +// Provides a summary of the predictor properties that are used in the ListPredictors +// operation. To get the complete set of properties, call the DescribePredictor +// operation, and provide the listed PredictorArn. +type PredictorSummary struct { + _ struct{} `type:"structure"` + + // When the model training task was created. + CreationTime *time.Time `type:"timestamp"` + + // The Amazon Resource Name (ARN) of the dataset group that contains the data + // 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: + // + // * 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 ARN of the predictor. + PredictorArn *string `type:"string"` + + // 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 + // + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // + // * CREATE_STOPPING, CREATE_STOPPED + // + // The Status of the predictor must be ACTIVE before you can use the predictor + // to create a forecast. + 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 PredictorSummary) 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 PredictorSummary) GoString() string { + return s.String() +} + +// SetCreationTime sets the CreationTime field's value. +func (s *PredictorSummary) SetCreationTime(v time.Time) *PredictorSummary { + s.CreationTime = &v + return s +} + +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *PredictorSummary) SetDatasetGroupArn(v string) *PredictorSummary { + s.DatasetGroupArn = &v + 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 + return s +} + +// SetMessage sets the Message field's value. +func (s *PredictorSummary) SetMessage(v string) *PredictorSummary { + s.Message = &v + return s +} + +// SetPredictorArn sets the PredictorArn field's value. +func (s *PredictorSummary) SetPredictorArn(v string) *PredictorSummary { + s.PredictorArn = &v + return s +} + +// SetPredictorName sets the PredictorName field's value. +func (s *PredictorSummary) SetPredictorName(v string) *PredictorSummary { + s.PredictorName = &v + 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"` + 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 ResourceAlreadyExistsException) 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 ResourceAlreadyExistsException) GoString() string { + return s.String() +} + +func newErrorResourceAlreadyExistsException(v protocol.ResponseMetadata) error { + return &ResourceAlreadyExistsException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ResourceAlreadyExistsException) Code() string { + return "ResourceAlreadyExistsException" +} + +// Message returns the exception's message. +func (s *ResourceAlreadyExistsException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ResourceAlreadyExistsException) OrigErr() error { + return nil +} + +func (s *ResourceAlreadyExistsException) 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 *ResourceAlreadyExistsException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ResourceAlreadyExistsException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The specified resource is in use. +type ResourceInUseException 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 ResourceInUseException) 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 ResourceInUseException) GoString() string { + return s.String() +} + +func newErrorResourceInUseException(v protocol.ResponseMetadata) error { + return &ResourceInUseException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ResourceInUseException) Code() string { + return "ResourceInUseException" +} + +// Message returns the exception's message. +func (s *ResourceInUseException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ResourceInUseException) OrigErr() error { + return nil +} + +func (s *ResourceInUseException) 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 *ResourceInUseException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ResourceInUseException) RequestID() string { + return s.RespMetadata.RequestID +} + +// We can't find a resource with that Amazon Resource Name (ARN). Check the +// ARN and try again. +type ResourceNotFoundException 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 ResourceNotFoundException) 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 ResourceNotFoundException) GoString() string { + return s.String() +} + +func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error { + return &ResourceNotFoundException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ResourceNotFoundException) Code() string { + return "ResourceNotFoundException" +} + +// Message returns the exception's message. +func (s *ResourceNotFoundException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// 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 +} + +type ResumeResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the monitor resource to resume. + // + // ResourceArn is a required field + ResourceArn *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 ResumeResourceInput) 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 ResumeResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ResumeResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ResumeResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *ResumeResourceInput) SetResourceArn(v string) *ResumeResourceInput { + s.ResourceArn = &v + return s +} + +type ResumeResourceOutput 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 ResumeResourceOutput) 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 ResumeResourceOutput) GoString() string { + return s.String() +} + +// The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, +// and an AWS Identity and Access Management (IAM) role that Amazon Forecast +// can assume to access the file(s). Optionally, includes an AWS Key Management +// Service (KMS) key. This object is part of the DataSource object that is submitted +// in the CreateDatasetImportJob request, and part of the DataDestination object. +type S3Config struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key. + KMSKeyArn *string `type:"string"` + + // The path to an Amazon Simple Storage Service (Amazon S3) bucket or file(s) + // in an Amazon S3 bucket. + // + // Path is a required field + 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 + // 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. + // + // 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 S3Config) 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 S3Config) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *S3Config) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "S3Config"} + 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")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKMSKeyArn sets the KMSKeyArn field's value. +func (s *S3Config) SetKMSKeyArn(v string) *S3Config { + s.KMSKeyArn = &v + return s +} + +// SetPath sets the Path field's value. +func (s *S3Config) SetPath(v string) *S3Config { + s.Path = &v + return s +} + +// SetRoleArn sets the RoleArn field's value. +func (s *S3Config) SetRoleArn(v string) *S3Config { + s.RoleArn = &v + return s +} + +// Defines the fields of a dataset. +type Schema struct { + _ struct{} `type:"structure"` + + // An array of attributes specifying the name and type of each field in a dataset. + Attributes []*SchemaAttribute `min:"1" 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 Schema) 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 Schema) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Schema) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Schema"} + if s.Attributes != nil && len(s.Attributes) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Attributes", 1)) + } + if s.Attributes != nil { + for i, v := range s.Attributes { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Attributes", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAttributes sets the Attributes field's value. +func (s *Schema) SetAttributes(v []*SchemaAttribute) *Schema { + s.Attributes = v + return s +} + +// An attribute of a schema, which defines a dataset field. A schema attribute +// is required for every field in a dataset. The Schema (https://docs.aws.amazon.com/forecast/latest/dg/API_Schema.html) +// object contains an array of SchemaAttribute objects. +type SchemaAttribute struct { + _ struct{} `type:"structure"` + + // The name of the dataset field. + AttributeName *string `min:"1" type:"string"` + + // The data type of the field. + // + // For a related time series dataset, other than date, item_id, and forecast + // dimensions attributes, all attributes should be of numerical type (integer/float). + AttributeType *string `type:"string" enum:"AttributeType"` +} + +// 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 SchemaAttribute) 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 SchemaAttribute) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SchemaAttribute) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SchemaAttribute"} + if s.AttributeName != nil && len(*s.AttributeName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AttributeName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAttributeName sets the AttributeName field's value. +func (s *SchemaAttribute) SetAttributeName(v string) *SchemaAttribute { + s.AttributeName = &v + return s +} + +// SetAttributeType sets the AttributeType field's value. +func (s *SchemaAttribute) SetAttributeType(v string) *SchemaAttribute { + s.AttributeType = &v + return s +} + +// Provides statistics for each data field imported into to an Amazon Forecast +// dataset with the CreateDatasetImportJob (https://docs.aws.amazon.com/forecast/latest/dg/API_CreateDatasetImportJob.html) +// operation. +type Statistics struct { + _ struct{} `type:"structure"` + + // For a numeric field, the average value in the field. + Avg *float64 `type:"double"` + + // The number of values in the field. If the response value is -1, refer to + // CountLong. + Count *int64 `type:"integer"` + + // The number of distinct values in the field. If the response value is -1, + // refer to CountDistinctLong. + CountDistinct *int64 `type:"integer"` + + // The number of distinct values in the field. CountDistinctLong is used instead + // of CountDistinct if the value is greater than 2,147,483,647. + CountDistinctLong *int64 `type:"long"` + + // The number of values in the field. CountLong is used instead of Count if + // the value is greater than 2,147,483,647. + CountLong *int64 `type:"long"` + + // The number of NAN (not a number) values in the field. If the response value + // is -1, refer to CountNanLong. + CountNan *int64 `type:"integer"` + + // The number of NAN (not a number) values in the field. CountNanLong is used + // instead of CountNan if the value is greater than 2,147,483,647. + CountNanLong *int64 `type:"long"` + + // The number of null values in the field. If the response value is -1, refer + // to CountNullLong. + CountNull *int64 `type:"integer"` + + // The number of null values in the field. CountNullLong is used instead of + // CountNull if the value is greater than 2,147,483,647. + CountNullLong *int64 `type:"long"` + + // For a numeric field, the maximum value in the field. + Max *string `type:"string"` + + // For a numeric field, the minimum value in the field. + Min *string `type:"string"` + + // For a numeric field, the standard deviation. + Stddev *float64 `type:"double"` +} + +// 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 Statistics) 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 Statistics) GoString() string { + return s.String() +} + +// SetAvg sets the Avg field's value. +func (s *Statistics) SetAvg(v float64) *Statistics { + s.Avg = &v + return s +} + +// SetCount sets the Count field's value. +func (s *Statistics) SetCount(v int64) *Statistics { + s.Count = &v + return s +} + +// SetCountDistinct sets the CountDistinct field's value. +func (s *Statistics) SetCountDistinct(v int64) *Statistics { + s.CountDistinct = &v + return s +} + +// SetCountDistinctLong sets the CountDistinctLong field's value. +func (s *Statistics) SetCountDistinctLong(v int64) *Statistics { + s.CountDistinctLong = &v + return s +} + +// SetCountLong sets the CountLong field's value. +func (s *Statistics) SetCountLong(v int64) *Statistics { + s.CountLong = &v + return s +} + +// SetCountNan sets the CountNan field's value. +func (s *Statistics) SetCountNan(v int64) *Statistics { + s.CountNan = &v + return s +} + +// SetCountNanLong sets the CountNanLong field's value. +func (s *Statistics) SetCountNanLong(v int64) *Statistics { + s.CountNanLong = &v + return s +} + +// SetCountNull sets the CountNull field's value. +func (s *Statistics) SetCountNull(v int64) *Statistics { + s.CountNull = &v + return s +} + +// SetCountNullLong sets the CountNullLong field's value. +func (s *Statistics) SetCountNullLong(v int64) *Statistics { + s.CountNullLong = &v + return s +} + +// SetMax sets the Max field's value. +func (s *Statistics) SetMax(v string) *Statistics { + s.Max = &v + return s +} + +// SetMin sets the Min field's value. +func (s *Statistics) SetMin(v string) *Statistics { + s.Min = &v + return s +} + +// SetStddev sets the Stddev field's value. +func (s *Statistics) SetStddev(v float64) *Statistics { + s.Stddev = &v + return s +} + +type StopResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) that identifies the resource to stop. The + // supported ARNs are DatasetImportJobArn, PredictorArn, PredictorBacktestExportJobArn, + // ForecastArn, ForecastExportJobArn, ExplainabilityArn, and ExplainabilityExportArn. + // + // ResourceArn is a required field + ResourceArn *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 StopResourceInput) 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 StopResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StopResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StopResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *StopResourceInput) SetResourceArn(v string) *StopResourceInput { + s.ResourceArn = &v + return s +} + +type StopResourceOutput 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 StopResourceOutput) 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 StopResourceOutput) GoString() string { + return s.String() +} + +// This object belongs to the CreatePredictor operation. If you created your +// predictor with CreateAutoPredictor, see AdditionalDataset. +// +// Describes a supplementary feature of a dataset group. This object is part +// of the InputDataConfig object. Forecast supports the Weather Index and Holidays +// built-in featurizations. +// +// # Weather Index +// +// The Amazon Forecast Weather Index is a built-in featurization 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 featurization that incorporates a feature-engineered +// dataset of 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 SupplementaryFeature struct { + _ struct{} `type:"structure"` + + // The name of the feature. Valid values: "holiday" and "weather". + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true"` + + // 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: + // + // * "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 + // + // Value is a required field + Value *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 SupplementaryFeature) 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 SupplementaryFeature) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SupplementaryFeature) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SupplementaryFeature"} + 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.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetName sets the Name field's value. +func (s *SupplementaryFeature) SetName(v string) *SupplementaryFeature { + s.Name = &v + return s +} + +// SetValue sets the Value field's value. +func (s *SupplementaryFeature) SetValue(v string) *SupplementaryFeature { + s.Value = &v + return s +} + +// The optional metadata that you apply to a resource 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. +type Tag struct { + _ struct{} `type:"structure"` + + // One part of a key-value pair that makes up a tag. A key is a general label + // that acts like a category for more specific tag values. + // + // Key is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by Tag's + // String and GoString methods. + // + // Key is a required field + Key *string `min:"1" type:"string" required:"true" sensitive:"true"` + + // The optional part of a key-value pair that makes up a tag. A value acts as + // a descriptor within a tag category (key). + // + // Value is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by Tag's + // String and GoString methods. + // + // Value is a required field + Value *string `type:"string" required:"true" sensitive:"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 Tag) 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 Tag) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Tag) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Tag"} + if s.Key == nil { + invalidParams.Add(request.NewErrParamRequired("Key")) + } + if s.Key != nil && len(*s.Key) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Key", 1)) + } + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKey sets the Key field's value. +func (s *Tag) SetKey(v string) *Tag { + s.Key = &v + return s +} + +// SetValue sets the Value field's value. +func (s *Tag) SetValue(v string) *Tag { + s.Value = &v + return s +} + +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) that identifies the resource for which to + // list the tags. + // + // ResourceArn is a required field + ResourceArn *string `type:"string" required:"true"` + + // The tags to add to the resource. A tag is an array of key-value pairs. + // + // 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 is a required field + Tags []*Tag `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 TagResourceInput) 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 TagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + 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 } -// SetName sets the Name field's value. -func (s *SupplementaryFeature) SetName(v string) *SupplementaryFeature { - s.Name = &v +// SetResourceArn sets the ResourceArn field's value. +func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput { + s.ResourceArn = &v return s } -// SetValue sets the Value field's value. -func (s *SupplementaryFeature) SetValue(v string) *SupplementaryFeature { - s.Value = &v +// SetTags sets the Tags field's value. +func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput { + s.Tags = v return s } -// The optional metadata that you apply to a resource to help you categorize -// and organize them. Each tag consists of a key and an optional value, both -// of which you define. +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. // -// The following basic restrictions apply to tags: +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. // -// - Maximum number of tags per resource - 50. +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) GoString() string { + return s.String() +} + +// The status, start time, and end time of a backtest, as well as a failure +// reason if applicable. +type TestWindowSummary struct { + _ struct{} `type:"structure"` + + // If the test failed, the reason why it failed. + Message *string `type:"string"` + + // The status of the test. Possible status values are: + // + // * ACTIVE + // + // * CREATE_IN_PROGRESS + // + // * CREATE_FAILED + Status *string `type:"string"` + + // The time at which the test ended. + TestWindowEnd *time.Time `type:"timestamp"` + + // The time at which the test began. + TestWindowStart *time.Time `type:"timestamp"` +} + +// String returns the string representation. // -// - For each resource, each tag key must be unique, and each tag key can -// have only one value. +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TestWindowSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. // -// - Maximum key length - 128 Unicode characters in UTF-8. +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TestWindowSummary) GoString() string { + return s.String() +} + +// SetMessage sets the Message field's value. +func (s *TestWindowSummary) SetMessage(v string) *TestWindowSummary { + s.Message = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *TestWindowSummary) SetStatus(v string) *TestWindowSummary { + s.Status = &v + return s +} + +// SetTestWindowEnd sets the TestWindowEnd field's value. +func (s *TestWindowSummary) SetTestWindowEnd(v time.Time) *TestWindowSummary { + s.TestWindowEnd = &v + return s +} + +// SetTestWindowStart sets the TestWindowStart field's value. +func (s *TestWindowSummary) SetTestWindowStart(v time.Time) *TestWindowSummary { + s.TestWindowStart = &v + return s +} + +// The time boundary Forecast uses to align and aggregate your data to match +// your forecast frequency. Provide the unit of time and the time boundary as +// a key value pair. If you don't provide a time boundary, Forecast uses a set +// of Default Time Boundaries (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries). // -// - Maximum value length - 256 Unicode characters in UTF-8. +// For more information about aggregation, see Data Aggregation for Different +// Forecast Frequencies (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html). +// For more information setting a custom time boundary, see Specifying a Time +// Boundary (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary). +type TimeAlignmentBoundary struct { + _ struct{} `type:"structure"` + + // The day of the month to use for time alignment during aggregation. + DayOfMonth *int64 `min:"1" type:"integer"` + + // The day of week to use for time alignment during aggregation. The day must + // be in uppercase. + DayOfWeek *string `type:"string" enum:"DayOfWeek"` + + // The hour of day to use for time alignment during aggregation. + Hour *int64 `type:"integer"` + + // The month to use for time alignment during aggregation. The month must be + // in uppercase. + Month *string `type:"string" enum:"Month"` +} + +// String returns the string representation. // -// - 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: + - = . _ : / @. +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TimeAlignmentBoundary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. // -// - Tag keys and values are case sensitive. +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TimeAlignmentBoundary) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TimeAlignmentBoundary) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TimeAlignmentBoundary"} + if s.DayOfMonth != nil && *s.DayOfMonth < 1 { + invalidParams.Add(request.NewErrParamMinValue("DayOfMonth", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDayOfMonth sets the DayOfMonth field's value. +func (s *TimeAlignmentBoundary) SetDayOfMonth(v int64) *TimeAlignmentBoundary { + s.DayOfMonth = &v + return s +} + +// SetDayOfWeek sets the DayOfWeek field's value. +func (s *TimeAlignmentBoundary) SetDayOfWeek(v string) *TimeAlignmentBoundary { + s.DayOfWeek = &v + return s +} + +// SetHour sets the Hour field's value. +func (s *TimeAlignmentBoundary) SetHour(v int64) *TimeAlignmentBoundary { + s.Hour = &v + return s +} + +// SetMonth sets the Month field's value. +func (s *TimeAlignmentBoundary) SetMonth(v string) *TimeAlignmentBoundary { + s.Month = &v + return s +} + +// Creates a subset of items within an attribute that are modified. For example, +// you can use this operation to create a subset of items that cost $5 or less. +// To do this, you specify "AttributeName": "price", "AttributeValue": "5", +// and "Condition": "LESS_THAN". Pair this operation with the Action operation +// within the CreateWhatIfForecastRequest$TimeSeriesTransformations operation +// to define how the attribute is modified. +type TimeSeriesCondition struct { + _ struct{} `type:"structure"` + + // The item_id, dimension name, IM name, or timestamp that you are modifying. + // + // AttributeName is a required field + AttributeName *string `min:"1" type:"string" required:"true"` + + // The value that is applied for the chosen Condition. + // + // AttributeValue is a required field + AttributeValue *string `type:"string" required:"true"` + + // The condition to apply. Valid values are EQUALS, NOT_EQUALS, LESS_THAN and + // GREATER_THAN. + // + // Condition is a required field + Condition *string `type:"string" required:"true" enum:"Condition"` +} + +// String returns the string representation. // -// - 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. -type Tag 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 TimeSeriesCondition) 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 TimeSeriesCondition) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TimeSeriesCondition) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TimeSeriesCondition"} + if s.AttributeName == nil { + invalidParams.Add(request.NewErrParamRequired("AttributeName")) + } + if s.AttributeName != nil && len(*s.AttributeName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AttributeName", 1)) + } + if s.AttributeValue == nil { + invalidParams.Add(request.NewErrParamRequired("AttributeValue")) + } + if s.Condition == nil { + invalidParams.Add(request.NewErrParamRequired("Condition")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAttributeName sets the AttributeName field's value. +func (s *TimeSeriesCondition) SetAttributeName(v string) *TimeSeriesCondition { + s.AttributeName = &v + return s +} + +// SetAttributeValue sets the AttributeValue field's value. +func (s *TimeSeriesCondition) SetAttributeValue(v string) *TimeSeriesCondition { + s.AttributeValue = &v + return s +} + +// SetCondition sets the Condition field's value. +func (s *TimeSeriesCondition) SetCondition(v string) *TimeSeriesCondition { + s.Condition = &v + return s +} + +// Details about the import file that contains the time series for which you +// want to create forecasts. +type TimeSeriesIdentifiers struct { _ struct{} `type:"structure"` - // One part of a key-value pair that makes up a tag. A key is a general label - // that acts like a category for more specific tag values. - // - // Key is a sensitive parameter and its value will be - // replaced with "sensitive" in string returned by Tag's - // String and GoString methods. - // - // Key is a required field - Key *string `min:"1" type:"string" required:"true" sensitive:"true"` + // The source of your 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. + DataSource *DataSource `type:"structure"` - // The optional part of a key-value pair that makes up a tag. A value acts as - // a descriptor within a tag category (key). - // - // Value is a sensitive parameter and its value will be - // replaced with "sensitive" in string returned by Tag's - // String and GoString methods. - // - // Value is a required field - Value *string `type:"string" required:"true" sensitive:"true"` + // The format of the data, either CSV or PARQUET. + Format *string `type:"string"` + + // Defines the fields of a dataset. + Schema *Schema `type:"structure"` } // String returns the string representation. @@ -17262,7 +20725,7 @@ type Tag 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 Tag) String() string { +func (s TimeSeriesIdentifiers) String() string { return awsutil.Prettify(s) } @@ -17271,21 +20734,22 @@ func (s Tag) 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 Tag) GoString() string { +func (s TimeSeriesIdentifiers) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *Tag) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "Tag"} - if s.Key == nil { - invalidParams.Add(request.NewErrParamRequired("Key")) - } - if s.Key != nil && len(*s.Key) < 1 { - invalidParams.Add(request.NewErrParamMinLen("Key", 1)) +func (s *TimeSeriesIdentifiers) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TimeSeriesIdentifiers"} + if s.DataSource != nil { + if err := s.DataSource.Validate(); err != nil { + invalidParams.AddNested("DataSource", err.(request.ErrInvalidParams)) + } } - if s.Value == nil { - invalidParams.Add(request.NewErrParamRequired("Value")) + if s.Schema != nil { + if err := s.Schema.Validate(); err != nil { + invalidParams.AddNested("Schema", err.(request.ErrInvalidParams)) + } } if invalidParams.Len() > 0 { @@ -17294,57 +20758,52 @@ func (s *Tag) Validate() error { return nil } -// SetKey sets the Key field's value. -func (s *Tag) SetKey(v string) *Tag { - s.Key = &v +// SetDataSource sets the DataSource field's value. +func (s *TimeSeriesIdentifiers) SetDataSource(v *DataSource) *TimeSeriesIdentifiers { + s.DataSource = v return s } -// SetValue sets the Value field's value. -func (s *Tag) SetValue(v string) *Tag { - s.Value = &v +// SetFormat sets the Format field's value. +func (s *TimeSeriesIdentifiers) SetFormat(v string) *TimeSeriesIdentifiers { + s.Format = &v return s } -type TagResourceInput struct { +// SetSchema sets the Schema field's value. +func (s *TimeSeriesIdentifiers) SetSchema(v *Schema) *TimeSeriesIdentifiers { + s.Schema = v + return s +} + +// A replacement dataset is a modified version of the baseline related time +// series that contains only the values that you want to include in a what-if +// forecast. The replacement dataset must contain the forecast dimensions and +// item identifiers in the baseline related time series as well as at least +// 1 changed time series. This dataset is merged with the baseline related time +// series to create a transformed dataset that is used for the what-if forecast. +type TimeSeriesReplacementsDataSource struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that identifies the resource for which to - // list the tags. - // - // ResourceArn is a required field - ResourceArn *string `type:"string" required:"true"` + // The format of the replacement data, CSV or PARQUET. + Format *string `type:"string"` - // The tags to add to the resource. A tag is an array of key-value pairs. - // - // 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. + // The path to the file(s) in an Amazon Simple Storage Service (Amazon S3) bucket, + // and an AWS Identity and Access Management (IAM) role that Amazon Forecast + // can assume to access the file(s). Optionally, includes an AWS Key Management + // Service (KMS) key. This object is part of the DataSource object that is submitted + // in the CreateDatasetImportJob request, and part of the DataDestination object. // - // * 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. + // S3Config is a required field + S3Config *S3Config `type:"structure" required:"true"` + + // Defines the fields of a dataset. // - // Tags is a required field - Tags []*Tag `type:"list" required:"true"` + // Schema is a required field + Schema *Schema `type:"structure" required:"true"` + + // The timestamp format of the replacement data. + TimestampFormat *string `type:"string"` } // String returns the string representation. @@ -17352,7 +20811,7 @@ type TagResourceInput 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 TagResourceInput) String() string { +func (s TimeSeriesReplacementsDataSource) String() string { return awsutil.Prettify(s) } @@ -17361,27 +20820,27 @@ func (s TagResourceInput) 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 TagResourceInput) GoString() string { +func (s TimeSeriesReplacementsDataSource) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *TagResourceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} - if s.ResourceArn == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceArn")) +func (s *TimeSeriesReplacementsDataSource) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TimeSeriesReplacementsDataSource"} + if s.S3Config == nil { + invalidParams.Add(request.NewErrParamRequired("S3Config")) } - if s.Tags == nil { - invalidParams.Add(request.NewErrParamRequired("Tags")) + if s.Schema == nil { + invalidParams.Add(request.NewErrParamRequired("Schema")) } - 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.S3Config != nil { + if err := s.S3Config.Validate(); err != nil { + invalidParams.AddNested("S3Config", err.(request.ErrInvalidParams)) + } + } + if s.Schema != nil { + if err := s.Schema.Validate(); err != nil { + invalidParams.AddNested("Schema", err.(request.ErrInvalidParams)) } } @@ -17391,20 +20850,46 @@ func (s *TagResourceInput) Validate() error { return nil } -// SetResourceArn sets the ResourceArn field's value. -func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput { - s.ResourceArn = &v +// SetFormat sets the Format field's value. +func (s *TimeSeriesReplacementsDataSource) SetFormat(v string) *TimeSeriesReplacementsDataSource { + s.Format = &v return s } -// SetTags sets the Tags field's value. -func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput { - s.Tags = v +// SetS3Config sets the S3Config field's value. +func (s *TimeSeriesReplacementsDataSource) SetS3Config(v *S3Config) *TimeSeriesReplacementsDataSource { + s.S3Config = v return s } -type TagResourceOutput struct { +// SetSchema sets the Schema field's value. +func (s *TimeSeriesReplacementsDataSource) SetSchema(v *Schema) *TimeSeriesReplacementsDataSource { + s.Schema = v + return s +} + +// SetTimestampFormat sets the TimestampFormat field's value. +func (s *TimeSeriesReplacementsDataSource) SetTimestampFormat(v string) *TimeSeriesReplacementsDataSource { + s.TimestampFormat = &v + return s +} + +// Defines the set of time series that are used to create the forecasts in a +// TimeSeriesIdentifiers object. +// +// The TimeSeriesIdentifiers object needs the following information: +// +// - DataSource +// +// - Format +// +// - Schema +type TimeSeriesSelector struct { _ struct{} `type:"structure"` + + // Details about the import file that contains the time series for which you + // want to create forecasts. + TimeSeriesIdentifiers *TimeSeriesIdentifiers `type:"structure"` } // String returns the string representation. @@ -17412,7 +20897,7 @@ type TagResourceOutput 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 TagResourceOutput) String() string { +func (s TimeSeriesSelector) String() string { return awsutil.Prettify(s) } @@ -17421,32 +20906,48 @@ func (s TagResourceOutput) 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 TagResourceOutput) GoString() string { +func (s TimeSeriesSelector) GoString() string { return s.String() } -// The status, start time, and end time of a backtest, as well as a failure -// reason if applicable. -type TestWindowSummary struct { - _ struct{} `type:"structure"` +// Validate inspects the fields of the type to determine if they are valid. +func (s *TimeSeriesSelector) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TimeSeriesSelector"} + if s.TimeSeriesIdentifiers != nil { + if err := s.TimeSeriesIdentifiers.Validate(); err != nil { + invalidParams.AddNested("TimeSeriesIdentifiers", err.(request.ErrInvalidParams)) + } + } - // If the test failed, the reason why it failed. - Message *string `type:"string"` + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} - // The status of the test. Possible status values are: - // - // * ACTIVE - // - // * CREATE_IN_PROGRESS - // - // * CREATE_FAILED - Status *string `type:"string"` +// SetTimeSeriesIdentifiers sets the TimeSeriesIdentifiers field's value. +func (s *TimeSeriesSelector) SetTimeSeriesIdentifiers(v *TimeSeriesIdentifiers) *TimeSeriesSelector { + s.TimeSeriesIdentifiers = v + return s +} - // The time at which the test ended. - TestWindowEnd *time.Time `type:"timestamp"` +// A transformation function is a pair of operations that select and modify +// the rows in a related time series. You select the rows that you want with +// a condition operation and you modify the rows with a transformation operation. +// All conditions are joined with an AND operation, meaning that all conditions +// must be true for the transformation to be applied. Transformations are applied +// in the order that they are listed. +type TimeSeriesTransformation struct { + _ struct{} `type:"structure"` - // The time at which the test began. - TestWindowStart *time.Time `type:"timestamp"` + // An array of actions that define a time series and how it is transformed. + // These transformations create a new time series that is used for the what-if + // analysis. + Action *Action `type:"structure"` + + // An array of conditions that define which members of the related time series + // are transformed. + TimeSeriesConditions []*TimeSeriesCondition `type:"list"` } // String returns the string representation. @@ -17454,7 +20955,7 @@ type TestWindowSummary 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 TestWindowSummary) String() string { +func (s TimeSeriesTransformation) String() string { return awsutil.Prettify(s) } @@ -17463,59 +20964,60 @@ func (s TestWindowSummary) 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 TestWindowSummary) GoString() string { +func (s TimeSeriesTransformation) GoString() string { return s.String() } -// SetMessage sets the Message field's value. -func (s *TestWindowSummary) SetMessage(v string) *TestWindowSummary { - s.Message = &v - return s -} +// Validate inspects the fields of the type to determine if they are valid. +func (s *TimeSeriesTransformation) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TimeSeriesTransformation"} + if s.Action != nil { + if err := s.Action.Validate(); err != nil { + invalidParams.AddNested("Action", err.(request.ErrInvalidParams)) + } + } + if s.TimeSeriesConditions != nil { + for i, v := range s.TimeSeriesConditions { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "TimeSeriesConditions", i), err.(request.ErrInvalidParams)) + } + } + } -// SetStatus sets the Status field's value. -func (s *TestWindowSummary) SetStatus(v string) *TestWindowSummary { - s.Status = &v - return s + if invalidParams.Len() > 0 { + return invalidParams + } + return nil } -// SetTestWindowEnd sets the TestWindowEnd field's value. -func (s *TestWindowSummary) SetTestWindowEnd(v time.Time) *TestWindowSummary { - s.TestWindowEnd = &v +// SetAction sets the Action field's value. +func (s *TimeSeriesTransformation) SetAction(v *Action) *TimeSeriesTransformation { + s.Action = v return s } -// SetTestWindowStart sets the TestWindowStart field's value. -func (s *TestWindowSummary) SetTestWindowStart(v time.Time) *TestWindowSummary { - s.TestWindowStart = &v +// SetTimeSeriesConditions sets the TimeSeriesConditions field's value. +func (s *TimeSeriesTransformation) SetTimeSeriesConditions(v []*TimeSeriesCondition) *TimeSeriesTransformation { + s.TimeSeriesConditions = v return s } -// The time boundary Forecast uses to align and aggregate your data to match -// your forecast frequency. Provide the unit of time and the time boundary as -// a key value pair. If you don't provide a time boundary, Forecast uses a set -// of Default Time Boundaries (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries). -// -// For more information about aggregation, see Data Aggregation for Different -// Forecast Frequencies (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html). -// For more information setting a custom time boundary, see Specifying a Time -// Boundary (https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary). -type TimeAlignmentBoundary struct { +type UntagResourceInput struct { _ struct{} `type:"structure"` - // The day of the month to use for time alignment during aggregation. - DayOfMonth *int64 `min:"1" type:"integer"` - - // The day of week to use for time alignment during aggregation. The day must - // be in uppercase. - DayOfWeek *string `type:"string" enum:"DayOfWeek"` - - // The hour of day to use for time alignment during aggregation. - Hour *int64 `type:"integer"` + // The Amazon Resource Name (ARN) that identifies the resource for which to + // list the tags. + // + // ResourceArn is a required field + ResourceArn *string `type:"string" required:"true"` - // The month to use for time alignment during aggregation. The month must be - // in uppercase. - Month *string `type:"string" enum:"Month"` + // The keys of the tags to be removed. + // + // TagKeys is a required field + TagKeys []*string `type:"list" required:"true"` } // String returns the string representation. @@ -17523,7 +21025,7 @@ type TimeAlignmentBoundary 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 TimeAlignmentBoundary) String() string { +func (s UntagResourceInput) String() string { return awsutil.Prettify(s) } @@ -17532,15 +21034,18 @@ func (s TimeAlignmentBoundary) 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 TimeAlignmentBoundary) GoString() string { +func (s UntagResourceInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *TimeAlignmentBoundary) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "TimeAlignmentBoundary"} - if s.DayOfMonth != nil && *s.DayOfMonth < 1 { - invalidParams.Add(request.NewErrParamMinValue("DayOfMonth", 1)) +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) } if invalidParams.Len() > 0 { @@ -17549,45 +21054,53 @@ func (s *TimeAlignmentBoundary) Validate() error { return nil } -// SetDayOfMonth sets the DayOfMonth field's value. -func (s *TimeAlignmentBoundary) SetDayOfMonth(v int64) *TimeAlignmentBoundary { - s.DayOfMonth = &v +// SetResourceArn sets the ResourceArn field's value. +func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { + s.ResourceArn = &v return s } -// SetDayOfWeek sets the DayOfWeek field's value. -func (s *TimeAlignmentBoundary) SetDayOfWeek(v string) *TimeAlignmentBoundary { - s.DayOfWeek = &v +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v return s } -// SetHour sets the Hour field's value. -func (s *TimeAlignmentBoundary) SetHour(v int64) *TimeAlignmentBoundary { - s.Hour = &v - return s +type UntagResourceOutput struct { + _ struct{} `type:"structure"` } -// SetMonth sets the Month field's value. -func (s *TimeAlignmentBoundary) SetMonth(v string) *TimeAlignmentBoundary { - s.Month = &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 UntagResourceOutput) String() string { + return awsutil.Prettify(s) } -// Details about the import file that contains the time series for which you -// want to create forecasts. -type TimeSeriesIdentifiers struct { - _ struct{} `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 UntagResourceOutput) GoString() string { + return s.String() +} - // The source of your 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. - DataSource *DataSource `type:"structure"` +type UpdateDatasetGroupInput struct { + _ struct{} `type:"structure"` - // The format of the data, either CSV or PARQUET. - Format *string `type:"string"` + // An array of the Amazon Resource Names (ARNs) of the datasets to add to the + // dataset group. + // + // DatasetArns is a required field + DatasetArns []*string `type:"list" required:"true"` - // Defines the fields of a dataset. - Schema *Schema `type:"structure"` + // The ARN of the dataset group. + // + // DatasetGroupArn is a required field + DatasetGroupArn *string `type:"string" required:"true"` } // String returns the string representation. @@ -17595,7 +21108,7 @@ type TimeSeriesIdentifiers 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 TimeSeriesIdentifiers) String() string { +func (s UpdateDatasetGroupInput) String() string { return awsutil.Prettify(s) } @@ -17604,22 +21117,18 @@ func (s TimeSeriesIdentifiers) 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 TimeSeriesIdentifiers) GoString() string { +func (s UpdateDatasetGroupInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *TimeSeriesIdentifiers) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "TimeSeriesIdentifiers"} - if s.DataSource != nil { - if err := s.DataSource.Validate(); err != nil { - invalidParams.AddNested("DataSource", err.(request.ErrInvalidParams)) - } +func (s *UpdateDatasetGroupInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateDatasetGroupInput"} + if s.DatasetArns == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetArns")) } - if s.Schema != nil { - if err := s.Schema.Validate(); err != nil { - invalidParams.AddNested("Schema", err.(request.ErrInvalidParams)) - } + if s.DatasetGroupArn == nil { + invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn")) } if invalidParams.Len() > 0 { @@ -17628,40 +21137,53 @@ func (s *TimeSeriesIdentifiers) Validate() error { return nil } -// SetDataSource sets the DataSource field's value. -func (s *TimeSeriesIdentifiers) SetDataSource(v *DataSource) *TimeSeriesIdentifiers { - s.DataSource = v +// SetDatasetArns sets the DatasetArns field's value. +func (s *UpdateDatasetGroupInput) SetDatasetArns(v []*string) *UpdateDatasetGroupInput { + s.DatasetArns = v return s } -// SetFormat sets the Format field's value. -func (s *TimeSeriesIdentifiers) SetFormat(v string) *TimeSeriesIdentifiers { - s.Format = &v +// SetDatasetGroupArn sets the DatasetGroupArn field's value. +func (s *UpdateDatasetGroupInput) SetDatasetGroupArn(v string) *UpdateDatasetGroupInput { + s.DatasetGroupArn = &v return s } -// SetSchema sets the Schema field's value. -func (s *TimeSeriesIdentifiers) SetSchema(v *Schema) *TimeSeriesIdentifiers { - s.Schema = v - return s +type UpdateDatasetGroupOutput struct { + _ struct{} `type:"structure"` } -// Defines the set of time series that are used to create the forecasts in a -// TimeSeriesIdentifiers object. -// -// The TimeSeriesIdentifiers object needs the following information: -// -// - DataSource +// String returns the string representation. // -// - Format +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateDatasetGroupOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. // -// - Schema -type TimeSeriesSelector 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 UpdateDatasetGroupOutput) GoString() string { + return s.String() +} + +// The weighted loss value for a quantile. This object is part of the Metrics +// object. +type WeightedQuantileLoss struct { _ struct{} `type:"structure"` - // Details about the import file that contains the time series for which you - // want to create forecasts. - TimeSeriesIdentifiers *TimeSeriesIdentifiers `type:"structure"` + // The difference between the predicted value and the actual value over the + // quantile, weighted (normalized) by dividing by the sum over all quantiles. + LossValue *float64 `type:"double"` + + // The quantile. Quantiles divide a probability distribution into regions of + // equal probability. For example, if the distribution was divided into 5 regions + // of equal probability, the quantiles would be 0.2, 0.4, 0.6, and 0.8. + Quantile *float64 `type:"double"` } // String returns the string representation. @@ -17669,7 +21191,7 @@ type TimeSeriesSelector 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 TimeSeriesSelector) String() string { +func (s WeightedQuantileLoss) String() string { return awsutil.Prettify(s) } @@ -17678,44 +21200,71 @@ func (s TimeSeriesSelector) 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 TimeSeriesSelector) GoString() string { +func (s WeightedQuantileLoss) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *TimeSeriesSelector) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "TimeSeriesSelector"} - if s.TimeSeriesIdentifiers != nil { - if err := s.TimeSeriesIdentifiers.Validate(); err != nil { - invalidParams.AddNested("TimeSeriesIdentifiers", err.(request.ErrInvalidParams)) - } - } - - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetLossValue sets the LossValue field's value. +func (s *WeightedQuantileLoss) SetLossValue(v float64) *WeightedQuantileLoss { + s.LossValue = &v + return s } -// SetTimeSeriesIdentifiers sets the TimeSeriesIdentifiers field's value. -func (s *TimeSeriesSelector) SetTimeSeriesIdentifiers(v *TimeSeriesIdentifiers) *TimeSeriesSelector { - s.TimeSeriesIdentifiers = v +// SetQuantile sets the Quantile field's value. +func (s *WeightedQuantileLoss) SetQuantile(v float64) *WeightedQuantileLoss { + s.Quantile = &v return s } -type UntagResourceInput struct { +// Provides a summary of the what-if analysis properties used in the ListWhatIfAnalyses +// operation. To get the complete set of properties, call the DescribeWhatIfAnalysis +// operation, and provide the WhatIfAnalysisArn that is listed in the summary. +type WhatIfAnalysisSummary struct { _ struct{} `type:"structure"` - // The Amazon Resource Name (ARN) that identifies the resource for which to - // list the tags. + // When the what-if analysis was created. + CreationTime *time.Time `type:"timestamp"` + + // The Amazon Resource Name (ARN) of the baseline forecast that is being used + // in this what-if analysis. + ForecastArn *string `type:"string"` + + // The last time the resource was modified. The timestamp depends on the status + // of the job: // - // ResourceArn is a required field - ResourceArn *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"` + + // If an error occurred, an informational message about the error. + Message *string `type:"string"` - // The keys of the tags to be removed. + // The status of the what-if analysis. States include: // - // TagKeys is a required field - TagKeys []*string `type:"list" required:"true"` + // * ACTIVE + // + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * CREATE_STOPPING, CREATE_STOPPED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // + // The Status of the what-if analysis must be ACTIVE before you can access the + // analysis. + Status *string `type:"string"` + + // The Amazon Resource Name (ARN) of the what-if analysis. + WhatIfAnalysisArn *string `type:"string"` + + // The name of the what-if analysis. + WhatIfAnalysisName *string `min:"1" type:"string"` } // String returns the string representation. @@ -17723,7 +21272,7 @@ type UntagResourceInput 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 UntagResourceInput) String() string { +func (s WhatIfAnalysisSummary) String() string { return awsutil.Prettify(s) } @@ -17732,73 +21281,106 @@ func (s UntagResourceInput) 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 UntagResourceInput) GoString() string { +func (s WhatIfAnalysisSummary) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *UntagResourceInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} - if s.ResourceArn == nil { - invalidParams.Add(request.NewErrParamRequired("ResourceArn")) - } - if s.TagKeys == nil { - invalidParams.Add(request.NewErrParamRequired("TagKeys")) - } +// SetCreationTime sets the CreationTime field's value. +func (s *WhatIfAnalysisSummary) SetCreationTime(v time.Time) *WhatIfAnalysisSummary { + s.CreationTime = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetForecastArn sets the ForecastArn field's value. +func (s *WhatIfAnalysisSummary) SetForecastArn(v string) *WhatIfAnalysisSummary { + s.ForecastArn = &v + return s } -// SetResourceArn sets the ResourceArn field's value. -func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { - s.ResourceArn = &v +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *WhatIfAnalysisSummary) SetLastModificationTime(v time.Time) *WhatIfAnalysisSummary { + s.LastModificationTime = &v return s } -// SetTagKeys sets the TagKeys field's value. -func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { - s.TagKeys = v +// SetMessage sets the Message field's value. +func (s *WhatIfAnalysisSummary) SetMessage(v string) *WhatIfAnalysisSummary { + s.Message = &v return s } -type UntagResourceOutput struct { - _ struct{} `type:"structure"` +// SetStatus sets the Status field's value. +func (s *WhatIfAnalysisSummary) SetStatus(v string) *WhatIfAnalysisSummary { + s.Status = &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 UntagResourceOutput) String() string { - return awsutil.Prettify(s) +// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value. +func (s *WhatIfAnalysisSummary) SetWhatIfAnalysisArn(v string) *WhatIfAnalysisSummary { + s.WhatIfAnalysisArn = &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 UntagResourceOutput) GoString() string { - return s.String() +// SetWhatIfAnalysisName sets the WhatIfAnalysisName field's value. +func (s *WhatIfAnalysisSummary) SetWhatIfAnalysisName(v string) *WhatIfAnalysisSummary { + s.WhatIfAnalysisName = &v + return s } -type UpdateDatasetGroupInput struct { +// Provides a summary of the what-if forecast export properties used in the +// ListWhatIfForecastExports operation. To get the complete set of properties, +// call the DescribeWhatIfForecastExport operation, and provide the WhatIfForecastExportArn +// that is listed in the summary. +type WhatIfForecastExportSummary struct { _ struct{} `type:"structure"` - // An array of the Amazon Resource Names (ARNs) of the datasets to add to the - // dataset group. + // When the what-if forecast export was created. + CreationTime *time.Time `type:"timestamp"` + + // The path to the Amazon Simple Storage Service (Amazon S3) bucket where the + // forecast is exported. + Destination *DataDestination `type:"structure"` + + // The last time the resource was modified. The timestamp depends on the status + // of the job: // - // DatasetArns is a required field - DatasetArns []*string `type:"list" 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 dataset group. + // If an error occurred, an informational message about the error. + Message *string `type:"string"` + + // The status of the what-if forecast export. States include: // - // DatasetGroupArn is a required field - DatasetGroupArn *string `type:"string" required:"true"` + // * ACTIVE + // + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * CREATE_STOPPING, CREATE_STOPPED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // + // The Status of the what-if analysis must be ACTIVE before you can access the + // analysis. + Status *string `type:"string"` + + // An array of Amazon Resource Names (ARNs) that define the what-if forecasts + // included in the export. + WhatIfForecastArns []*string `min:"1" type:"list"` + + // The Amazon Resource Name (ARN) of the what-if forecast export. + WhatIfForecastExportArn *string `type:"string"` + + // The what-if forecast export name. + WhatIfForecastExportName *string `min:"1" type:"string"` } // String returns the string representation. @@ -17806,7 +21388,7 @@ type UpdateDatasetGroupInput 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 UpdateDatasetGroupInput) String() string { +func (s WhatIfForecastExportSummary) String() string { return awsutil.Prettify(s) } @@ -17815,73 +21397,107 @@ func (s UpdateDatasetGroupInput) 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 UpdateDatasetGroupInput) GoString() string { +func (s WhatIfForecastExportSummary) GoString() string { return s.String() } -// Validate inspects the fields of the type to determine if they are valid. -func (s *UpdateDatasetGroupInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "UpdateDatasetGroupInput"} - if s.DatasetArns == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetArns")) - } - if s.DatasetGroupArn == nil { - invalidParams.Add(request.NewErrParamRequired("DatasetGroupArn")) - } +// SetCreationTime sets the CreationTime field's value. +func (s *WhatIfForecastExportSummary) SetCreationTime(v time.Time) *WhatIfForecastExportSummary { + s.CreationTime = &v + return s +} - if invalidParams.Len() > 0 { - return invalidParams - } - return nil +// SetDestination sets the Destination field's value. +func (s *WhatIfForecastExportSummary) SetDestination(v *DataDestination) *WhatIfForecastExportSummary { + s.Destination = v + return s } -// SetDatasetArns sets the DatasetArns field's value. -func (s *UpdateDatasetGroupInput) SetDatasetArns(v []*string) *UpdateDatasetGroupInput { - s.DatasetArns = v +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *WhatIfForecastExportSummary) SetLastModificationTime(v time.Time) *WhatIfForecastExportSummary { + s.LastModificationTime = &v return s } -// SetDatasetGroupArn sets the DatasetGroupArn field's value. -func (s *UpdateDatasetGroupInput) SetDatasetGroupArn(v string) *UpdateDatasetGroupInput { - s.DatasetGroupArn = &v +// SetMessage sets the Message field's value. +func (s *WhatIfForecastExportSummary) SetMessage(v string) *WhatIfForecastExportSummary { + s.Message = &v return s } -type UpdateDatasetGroupOutput struct { - _ struct{} `type:"structure"` +// SetStatus sets the Status field's value. +func (s *WhatIfForecastExportSummary) SetStatus(v string) *WhatIfForecastExportSummary { + s.Status = &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 UpdateDatasetGroupOutput) String() string { - return awsutil.Prettify(s) +// SetWhatIfForecastArns sets the WhatIfForecastArns field's value. +func (s *WhatIfForecastExportSummary) SetWhatIfForecastArns(v []*string) *WhatIfForecastExportSummary { + s.WhatIfForecastArns = 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 UpdateDatasetGroupOutput) GoString() string { - return s.String() +// SetWhatIfForecastExportArn sets the WhatIfForecastExportArn field's value. +func (s *WhatIfForecastExportSummary) SetWhatIfForecastExportArn(v string) *WhatIfForecastExportSummary { + s.WhatIfForecastExportArn = &v + return s } -// The weighted loss value for a quantile. This object is part of the Metrics -// object. -type WeightedQuantileLoss struct { +// SetWhatIfForecastExportName sets the WhatIfForecastExportName field's value. +func (s *WhatIfForecastExportSummary) SetWhatIfForecastExportName(v string) *WhatIfForecastExportSummary { + s.WhatIfForecastExportName = &v + return s +} + +// Provides a summary of the what-if forecast properties used in the ListWhatIfForecasts +// operation. To get the complete set of properties, call the DescribeWhatIfForecast +// operation, and provide the WhatIfForecastArn that is listed in the summary. +type WhatIfForecastSummary struct { _ struct{} `type:"structure"` - // The difference between the predicted value and the actual value over the - // quantile, weighted (normalized) by dividing by the sum over all quantiles. - LossValue *float64 `type:"double"` + // When the what-if forecast was created. + CreationTime *time.Time `type:"timestamp"` - // The quantile. Quantiles divide a probability distribution into regions of - // equal probability. For example, if the distribution was divided into 5 regions - // of equal probability, the quantiles would be 0.2, 0.4, 0.6, and 0.8. - Quantile *float64 `type:"double"` + // 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 what-if forecast. States include: + // + // * ACTIVE + // + // * CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED + // + // * CREATE_STOPPING, CREATE_STOPPED + // + // * DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED + // + // The Status of the what-if analysis must be ACTIVE before you can access the + // analysis. + Status *string `type:"string"` + + // The Amazon Resource Name (ARN) of the what-if analysis that contains this + // what-if forecast. + WhatIfAnalysisArn *string `type:"string"` + + // The Amazon Resource Name (ARN) of the what-if forecast. + WhatIfForecastArn *string `type:"string"` + + // The name of the what-if forecast. + WhatIfForecastName *string `min:"1" type:"string"` } // String returns the string representation. @@ -17889,7 +21505,7 @@ type WeightedQuantileLoss 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 WeightedQuantileLoss) String() string { +func (s WhatIfForecastSummary) String() string { return awsutil.Prettify(s) } @@ -17898,19 +21514,49 @@ func (s WeightedQuantileLoss) 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 WeightedQuantileLoss) GoString() string { +func (s WhatIfForecastSummary) GoString() string { return s.String() } -// SetLossValue sets the LossValue field's value. -func (s *WeightedQuantileLoss) SetLossValue(v float64) *WeightedQuantileLoss { - s.LossValue = &v +// SetCreationTime sets the CreationTime field's value. +func (s *WhatIfForecastSummary) SetCreationTime(v time.Time) *WhatIfForecastSummary { + s.CreationTime = &v return s } -// SetQuantile sets the Quantile field's value. -func (s *WeightedQuantileLoss) SetQuantile(v float64) *WeightedQuantileLoss { - s.Quantile = &v +// SetLastModificationTime sets the LastModificationTime field's value. +func (s *WhatIfForecastSummary) SetLastModificationTime(v time.Time) *WhatIfForecastSummary { + s.LastModificationTime = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *WhatIfForecastSummary) SetMessage(v string) *WhatIfForecastSummary { + s.Message = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *WhatIfForecastSummary) SetStatus(v string) *WhatIfForecastSummary { + s.Status = &v + return s +} + +// SetWhatIfAnalysisArn sets the WhatIfAnalysisArn field's value. +func (s *WhatIfForecastSummary) SetWhatIfAnalysisArn(v string) *WhatIfForecastSummary { + s.WhatIfAnalysisArn = &v + return s +} + +// SetWhatIfForecastArn sets the WhatIfForecastArn field's value. +func (s *WhatIfForecastSummary) SetWhatIfForecastArn(v string) *WhatIfForecastSummary { + s.WhatIfForecastArn = &v + return s +} + +// SetWhatIfForecastName sets the WhatIfForecastName field's value. +func (s *WhatIfForecastSummary) SetWhatIfForecastName(v string) *WhatIfForecastSummary { + s.WhatIfForecastName = &v return s } @@ -18034,6 +21680,30 @@ func AutoMLOverrideStrategy_Values() []string { } } +const ( + // ConditionEquals is a Condition enum value + ConditionEquals = "EQUALS" + + // ConditionNotEquals is a Condition enum value + ConditionNotEquals = "NOT_EQUALS" + + // ConditionLessThan is a Condition enum value + ConditionLessThan = "LESS_THAN" + + // ConditionGreaterThan is a Condition enum value + ConditionGreaterThan = "GREATER_THAN" +) + +// Condition_Values returns all elements of the Condition enum +func Condition_Values() []string { + return []string{ + ConditionEquals, + ConditionNotEquals, + ConditionLessThan, + ConditionGreaterThan, + } +} + const ( // DatasetTypeTargetTimeSeries is a DatasetType enum value DatasetTypeTargetTimeSeries = "TARGET_TIME_SERIES" @@ -18226,6 +21896,30 @@ func Month_Values() []string { } } +const ( + // OperationAdd is a Operation enum value + OperationAdd = "ADD" + + // OperationSubtract is a Operation enum value + OperationSubtract = "SUBTRACT" + + // OperationMultiply is a Operation enum value + OperationMultiply = "MULTIPLY" + + // OperationDivide is a Operation enum value + OperationDivide = "DIVIDE" +) + +// Operation_Values returns all elements of the Operation enum +func Operation_Values() []string { + return []string{ + OperationAdd, + OperationSubtract, + OperationMultiply, + OperationDivide, + } +} + const ( // OptimizationMetricWape is a OptimizationMetric enum value OptimizationMetricWape = "WAPE" diff --git a/service/forecastservice/forecastserviceiface/interface.go b/service/forecastservice/forecastserviceiface/interface.go index 56b3798dc2..41aba832e2 100644 --- a/service/forecastservice/forecastserviceiface/interface.go +++ b/service/forecastservice/forecastserviceiface/interface.go @@ -104,6 +104,18 @@ type ForecastServiceAPI interface { CreatePredictorBacktestExportJobWithContext(aws.Context, *forecastservice.CreatePredictorBacktestExportJobInput, ...request.Option) (*forecastservice.CreatePredictorBacktestExportJobOutput, error) CreatePredictorBacktestExportJobRequest(*forecastservice.CreatePredictorBacktestExportJobInput) (*request.Request, *forecastservice.CreatePredictorBacktestExportJobOutput) + CreateWhatIfAnalysis(*forecastservice.CreateWhatIfAnalysisInput) (*forecastservice.CreateWhatIfAnalysisOutput, error) + CreateWhatIfAnalysisWithContext(aws.Context, *forecastservice.CreateWhatIfAnalysisInput, ...request.Option) (*forecastservice.CreateWhatIfAnalysisOutput, error) + CreateWhatIfAnalysisRequest(*forecastservice.CreateWhatIfAnalysisInput) (*request.Request, *forecastservice.CreateWhatIfAnalysisOutput) + + CreateWhatIfForecast(*forecastservice.CreateWhatIfForecastInput) (*forecastservice.CreateWhatIfForecastOutput, error) + CreateWhatIfForecastWithContext(aws.Context, *forecastservice.CreateWhatIfForecastInput, ...request.Option) (*forecastservice.CreateWhatIfForecastOutput, error) + CreateWhatIfForecastRequest(*forecastservice.CreateWhatIfForecastInput) (*request.Request, *forecastservice.CreateWhatIfForecastOutput) + + CreateWhatIfForecastExport(*forecastservice.CreateWhatIfForecastExportInput) (*forecastservice.CreateWhatIfForecastExportOutput, error) + CreateWhatIfForecastExportWithContext(aws.Context, *forecastservice.CreateWhatIfForecastExportInput, ...request.Option) (*forecastservice.CreateWhatIfForecastExportOutput, error) + CreateWhatIfForecastExportRequest(*forecastservice.CreateWhatIfForecastExportInput) (*request.Request, *forecastservice.CreateWhatIfForecastExportOutput) + DeleteDataset(*forecastservice.DeleteDatasetInput) (*forecastservice.DeleteDatasetOutput, error) DeleteDatasetWithContext(aws.Context, *forecastservice.DeleteDatasetInput, ...request.Option) (*forecastservice.DeleteDatasetOutput, error) DeleteDatasetRequest(*forecastservice.DeleteDatasetInput) (*request.Request, *forecastservice.DeleteDatasetOutput) @@ -148,6 +160,18 @@ type ForecastServiceAPI interface { DeleteResourceTreeWithContext(aws.Context, *forecastservice.DeleteResourceTreeInput, ...request.Option) (*forecastservice.DeleteResourceTreeOutput, error) DeleteResourceTreeRequest(*forecastservice.DeleteResourceTreeInput) (*request.Request, *forecastservice.DeleteResourceTreeOutput) + DeleteWhatIfAnalysis(*forecastservice.DeleteWhatIfAnalysisInput) (*forecastservice.DeleteWhatIfAnalysisOutput, error) + DeleteWhatIfAnalysisWithContext(aws.Context, *forecastservice.DeleteWhatIfAnalysisInput, ...request.Option) (*forecastservice.DeleteWhatIfAnalysisOutput, error) + DeleteWhatIfAnalysisRequest(*forecastservice.DeleteWhatIfAnalysisInput) (*request.Request, *forecastservice.DeleteWhatIfAnalysisOutput) + + DeleteWhatIfForecast(*forecastservice.DeleteWhatIfForecastInput) (*forecastservice.DeleteWhatIfForecastOutput, error) + DeleteWhatIfForecastWithContext(aws.Context, *forecastservice.DeleteWhatIfForecastInput, ...request.Option) (*forecastservice.DeleteWhatIfForecastOutput, error) + DeleteWhatIfForecastRequest(*forecastservice.DeleteWhatIfForecastInput) (*request.Request, *forecastservice.DeleteWhatIfForecastOutput) + + DeleteWhatIfForecastExport(*forecastservice.DeleteWhatIfForecastExportInput) (*forecastservice.DeleteWhatIfForecastExportOutput, error) + DeleteWhatIfForecastExportWithContext(aws.Context, *forecastservice.DeleteWhatIfForecastExportInput, ...request.Option) (*forecastservice.DeleteWhatIfForecastExportOutput, error) + DeleteWhatIfForecastExportRequest(*forecastservice.DeleteWhatIfForecastExportInput) (*request.Request, *forecastservice.DeleteWhatIfForecastExportOutput) + DescribeAutoPredictor(*forecastservice.DescribeAutoPredictorInput) (*forecastservice.DescribeAutoPredictorOutput, error) DescribeAutoPredictorWithContext(aws.Context, *forecastservice.DescribeAutoPredictorInput, ...request.Option) (*forecastservice.DescribeAutoPredictorOutput, error) DescribeAutoPredictorRequest(*forecastservice.DescribeAutoPredictorInput) (*request.Request, *forecastservice.DescribeAutoPredictorOutput) @@ -192,6 +216,18 @@ type ForecastServiceAPI interface { DescribePredictorBacktestExportJobWithContext(aws.Context, *forecastservice.DescribePredictorBacktestExportJobInput, ...request.Option) (*forecastservice.DescribePredictorBacktestExportJobOutput, error) DescribePredictorBacktestExportJobRequest(*forecastservice.DescribePredictorBacktestExportJobInput) (*request.Request, *forecastservice.DescribePredictorBacktestExportJobOutput) + DescribeWhatIfAnalysis(*forecastservice.DescribeWhatIfAnalysisInput) (*forecastservice.DescribeWhatIfAnalysisOutput, error) + DescribeWhatIfAnalysisWithContext(aws.Context, *forecastservice.DescribeWhatIfAnalysisInput, ...request.Option) (*forecastservice.DescribeWhatIfAnalysisOutput, error) + DescribeWhatIfAnalysisRequest(*forecastservice.DescribeWhatIfAnalysisInput) (*request.Request, *forecastservice.DescribeWhatIfAnalysisOutput) + + DescribeWhatIfForecast(*forecastservice.DescribeWhatIfForecastInput) (*forecastservice.DescribeWhatIfForecastOutput, error) + DescribeWhatIfForecastWithContext(aws.Context, *forecastservice.DescribeWhatIfForecastInput, ...request.Option) (*forecastservice.DescribeWhatIfForecastOutput, error) + DescribeWhatIfForecastRequest(*forecastservice.DescribeWhatIfForecastInput) (*request.Request, *forecastservice.DescribeWhatIfForecastOutput) + + DescribeWhatIfForecastExport(*forecastservice.DescribeWhatIfForecastExportInput) (*forecastservice.DescribeWhatIfForecastExportOutput, error) + DescribeWhatIfForecastExportWithContext(aws.Context, *forecastservice.DescribeWhatIfForecastExportInput, ...request.Option) (*forecastservice.DescribeWhatIfForecastExportOutput, error) + DescribeWhatIfForecastExportRequest(*forecastservice.DescribeWhatIfForecastExportInput) (*request.Request, *forecastservice.DescribeWhatIfForecastExportOutput) + GetAccuracyMetrics(*forecastservice.GetAccuracyMetricsInput) (*forecastservice.GetAccuracyMetricsOutput, error) GetAccuracyMetricsWithContext(aws.Context, *forecastservice.GetAccuracyMetricsInput, ...request.Option) (*forecastservice.GetAccuracyMetricsOutput, error) GetAccuracyMetricsRequest(*forecastservice.GetAccuracyMetricsInput) (*request.Request, *forecastservice.GetAccuracyMetricsOutput) @@ -277,6 +313,27 @@ type ForecastServiceAPI interface { ListTagsForResourceWithContext(aws.Context, *forecastservice.ListTagsForResourceInput, ...request.Option) (*forecastservice.ListTagsForResourceOutput, error) ListTagsForResourceRequest(*forecastservice.ListTagsForResourceInput) (*request.Request, *forecastservice.ListTagsForResourceOutput) + ListWhatIfAnalyses(*forecastservice.ListWhatIfAnalysesInput) (*forecastservice.ListWhatIfAnalysesOutput, error) + ListWhatIfAnalysesWithContext(aws.Context, *forecastservice.ListWhatIfAnalysesInput, ...request.Option) (*forecastservice.ListWhatIfAnalysesOutput, error) + ListWhatIfAnalysesRequest(*forecastservice.ListWhatIfAnalysesInput) (*request.Request, *forecastservice.ListWhatIfAnalysesOutput) + + ListWhatIfAnalysesPages(*forecastservice.ListWhatIfAnalysesInput, func(*forecastservice.ListWhatIfAnalysesOutput, bool) bool) error + ListWhatIfAnalysesPagesWithContext(aws.Context, *forecastservice.ListWhatIfAnalysesInput, func(*forecastservice.ListWhatIfAnalysesOutput, bool) bool, ...request.Option) error + + ListWhatIfForecastExports(*forecastservice.ListWhatIfForecastExportsInput) (*forecastservice.ListWhatIfForecastExportsOutput, error) + ListWhatIfForecastExportsWithContext(aws.Context, *forecastservice.ListWhatIfForecastExportsInput, ...request.Option) (*forecastservice.ListWhatIfForecastExportsOutput, error) + ListWhatIfForecastExportsRequest(*forecastservice.ListWhatIfForecastExportsInput) (*request.Request, *forecastservice.ListWhatIfForecastExportsOutput) + + ListWhatIfForecastExportsPages(*forecastservice.ListWhatIfForecastExportsInput, func(*forecastservice.ListWhatIfForecastExportsOutput, bool) bool) error + ListWhatIfForecastExportsPagesWithContext(aws.Context, *forecastservice.ListWhatIfForecastExportsInput, func(*forecastservice.ListWhatIfForecastExportsOutput, bool) bool, ...request.Option) error + + ListWhatIfForecasts(*forecastservice.ListWhatIfForecastsInput) (*forecastservice.ListWhatIfForecastsOutput, error) + ListWhatIfForecastsWithContext(aws.Context, *forecastservice.ListWhatIfForecastsInput, ...request.Option) (*forecastservice.ListWhatIfForecastsOutput, error) + ListWhatIfForecastsRequest(*forecastservice.ListWhatIfForecastsInput) (*request.Request, *forecastservice.ListWhatIfForecastsOutput) + + ListWhatIfForecastsPages(*forecastservice.ListWhatIfForecastsInput, func(*forecastservice.ListWhatIfForecastsOutput, bool) bool) error + ListWhatIfForecastsPagesWithContext(aws.Context, *forecastservice.ListWhatIfForecastsInput, func(*forecastservice.ListWhatIfForecastsOutput, bool) bool, ...request.Option) error + ResumeResource(*forecastservice.ResumeResourceInput) (*forecastservice.ResumeResourceOutput, error) ResumeResourceWithContext(aws.Context, *forecastservice.ResumeResourceInput, ...request.Option) (*forecastservice.ResumeResourceOutput, error) ResumeResourceRequest(*forecastservice.ResumeResourceInput) (*request.Request, *forecastservice.ResumeResourceOutput) diff --git a/service/iotsitewise/api.go b/service/iotsitewise/api.go index ef04f72699..8ca44b2749 100644 --- a/service/iotsitewise/api.go +++ b/service/iotsitewise/api.go @@ -77,6 +77,9 @@ func (c *IoTSiteWise) AssociateAssetsRequest(input *AssociateAssetsInput) (req * // The request isn't valid. This can occur if your request contains malformed // JSON or unsupported characters. Check your request and try again. // +// - ResourceAlreadyExistsException +// The resource already exists. +// // - ResourceNotFoundException // The requested resource can't be found. // diff --git a/service/lexmodelsv2/api.go b/service/lexmodelsv2/api.go index e5ddd2364f..c89e3e2276 100644 --- a/service/lexmodelsv2/api.go +++ b/service/lexmodelsv2/api.go @@ -6101,6 +6101,113 @@ func (c *LexModelsV2) StartImportWithContext(ctx aws.Context, input *StartImport return out, req.Send() } +const opStopBotRecommendation = "StopBotRecommendation" + +// StopBotRecommendationRequest generates a "aws/request.Request" representing the +// client's request for the StopBotRecommendation 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 StopBotRecommendation for more information on using the StopBotRecommendation +// 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 StopBotRecommendationRequest method. +// req, resp := client.StopBotRecommendationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StopBotRecommendation +func (c *LexModelsV2) StopBotRecommendationRequest(input *StopBotRecommendationInput) (req *request.Request, output *StopBotRecommendationOutput) { + op := &request.Operation{ + Name: opStopBotRecommendation, + HTTPMethod: "PUT", + HTTPPath: "/bots/{botId}/botversions/{botVersion}/botlocales/{localeId}/botrecommendations/{botRecommendationId}/stopbotrecommendation", + } + + if input == nil { + input = &StopBotRecommendationInput{} + } + + output = &StopBotRecommendationOutput{} + req = c.newRequest(op, input, output) + return +} + +// StopBotRecommendation API operation for Amazon Lex Model Building V2. +// +// Stop an already running Bot Recommendation request. +// +// 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 Lex Model Building V2's +// API operation StopBotRecommendation for usage and error information. +// +// Returned Error Types: +// +// - ThrottlingException +// Your request rate is too high. Reduce the frequency of requests. +// +// - ServiceQuotaExceededException +// You have reached a quota for your bot. +// +// - ValidationException +// One of the input parameters in your request isn't valid. Check the parameters +// and try your request again. +// +// - ResourceNotFoundException +// You asked to describe a resource that doesn't exist. Check the resource that +// you are requesting and try again. +// +// - ConflictException +// The action that you tried to perform couldn't be completed because the resource +// is in a conflicting state. For example, deleting a bot that is in the CREATING +// state. Try your request again. +// +// - PreconditionFailedException +// Your request couldn't be completed because one or more request fields aren't +// valid. Check the fields in your request and try again. +// +// - ConflictException +// The action that you tried to perform couldn't be completed because the resource +// is in a conflicting state. For example, deleting a bot that is in the CREATING +// state. Try your request again. +// +// - InternalServerException +// The service encountered an unexpected condition. Try your request again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/models.lex.v2-2020-08-07/StopBotRecommendation +func (c *LexModelsV2) StopBotRecommendation(input *StopBotRecommendationInput) (*StopBotRecommendationOutput, error) { + req, out := c.StopBotRecommendationRequest(input) + return out, req.Send() +} + +// StopBotRecommendationWithContext is the same as StopBotRecommendation with the addition of +// the ability to pass a context and additional request options. +// +// See StopBotRecommendation 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 *LexModelsV2) StopBotRecommendationWithContext(ctx aws.Context, input *StopBotRecommendationInput, opts ...request.Option) (*StopBotRecommendationOutput, error) { + req, out := c.StopBotRecommendationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opTagResource = "TagResource" // TagResourceRequest generates a "aws/request.Request" representing the @@ -26355,6 +26462,180 @@ func (s *StillWaitingResponseSpecification) SetTimeoutInSeconds(v int64) *StillW return s } +type StopBotRecommendationInput struct { + _ struct{} `type:"structure" nopayload:"true"` + + // The unique identifier of the bot containing the bot recommendation to be + // stopped. + // + // BotId is a required field + BotId *string `location:"uri" locationName:"botId" min:"10" type:"string" required:"true"` + + // The unique identifier of the bot recommendation to be stopped. + // + // BotRecommendationId is a required field + BotRecommendationId *string `location:"uri" locationName:"botRecommendationId" min:"10" type:"string" required:"true"` + + // The version of the bot containing the bot recommendation. + // + // BotVersion is a required field + BotVersion *string `location:"uri" locationName:"botVersion" min:"5" type:"string" required:"true"` + + // The identifier of the language and locale of the bot recommendation to stop. + // The string must match one of the supported locales. For more information, + // see Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + // + // LocaleId is a required field + LocaleId *string `location:"uri" locationName:"localeId" 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 StopBotRecommendationInput) 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 StopBotRecommendationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StopBotRecommendationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StopBotRecommendationInput"} + if s.BotId == nil { + invalidParams.Add(request.NewErrParamRequired("BotId")) + } + if s.BotId != nil && len(*s.BotId) < 10 { + invalidParams.Add(request.NewErrParamMinLen("BotId", 10)) + } + if s.BotRecommendationId == nil { + invalidParams.Add(request.NewErrParamRequired("BotRecommendationId")) + } + if s.BotRecommendationId != nil && len(*s.BotRecommendationId) < 10 { + invalidParams.Add(request.NewErrParamMinLen("BotRecommendationId", 10)) + } + if s.BotVersion == nil { + invalidParams.Add(request.NewErrParamRequired("BotVersion")) + } + if s.BotVersion != nil && len(*s.BotVersion) < 5 { + invalidParams.Add(request.NewErrParamMinLen("BotVersion", 5)) + } + if s.LocaleId == nil { + invalidParams.Add(request.NewErrParamRequired("LocaleId")) + } + if s.LocaleId != nil && len(*s.LocaleId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("LocaleId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBotId sets the BotId field's value. +func (s *StopBotRecommendationInput) SetBotId(v string) *StopBotRecommendationInput { + s.BotId = &v + return s +} + +// SetBotRecommendationId sets the BotRecommendationId field's value. +func (s *StopBotRecommendationInput) SetBotRecommendationId(v string) *StopBotRecommendationInput { + s.BotRecommendationId = &v + return s +} + +// SetBotVersion sets the BotVersion field's value. +func (s *StopBotRecommendationInput) SetBotVersion(v string) *StopBotRecommendationInput { + s.BotVersion = &v + return s +} + +// SetLocaleId sets the LocaleId field's value. +func (s *StopBotRecommendationInput) SetLocaleId(v string) *StopBotRecommendationInput { + s.LocaleId = &v + return s +} + +type StopBotRecommendationOutput struct { + _ struct{} `type:"structure"` + + // The unique identifier of the bot containing the bot recommendation that is + // being stopped. + BotId *string `locationName:"botId" min:"10" type:"string"` + + // The unique identifier of the bot recommendation that is being stopped. + BotRecommendationId *string `locationName:"botRecommendationId" min:"10" type:"string"` + + // The status of the bot recommendation. If the status is Failed, then the reasons + // for the failure are listed in the failureReasons field. + BotRecommendationStatus *string `locationName:"botRecommendationStatus" type:"string" enum:"BotRecommendationStatus"` + + // The version of the bot containing the recommendation that is being stopped. + BotVersion *string `locationName:"botVersion" min:"5" type:"string"` + + // The identifier of the language and locale of the bot response to stop. The + // string must match one of the supported locales. For more information, see + // Supported languages (https://docs.aws.amazon.com/lexv2/latest/dg/how-languages.html) + LocaleId *string `locationName:"localeId" 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 StopBotRecommendationOutput) 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 StopBotRecommendationOutput) GoString() string { + return s.String() +} + +// SetBotId sets the BotId field's value. +func (s *StopBotRecommendationOutput) SetBotId(v string) *StopBotRecommendationOutput { + s.BotId = &v + return s +} + +// SetBotRecommendationId sets the BotRecommendationId field's value. +func (s *StopBotRecommendationOutput) SetBotRecommendationId(v string) *StopBotRecommendationOutput { + s.BotRecommendationId = &v + return s +} + +// SetBotRecommendationStatus sets the BotRecommendationStatus field's value. +func (s *StopBotRecommendationOutput) SetBotRecommendationStatus(v string) *StopBotRecommendationOutput { + s.BotRecommendationStatus = &v + return s +} + +// SetBotVersion sets the BotVersion field's value. +func (s *StopBotRecommendationOutput) SetBotVersion(v string) *StopBotRecommendationOutput { + s.BotVersion = &v + return s +} + +// SetLocaleId sets the LocaleId field's value. +func (s *StopBotRecommendationOutput) SetLocaleId(v string) *StopBotRecommendationOutput { + s.LocaleId = &v + return s +} + type TagResourceInput struct { _ struct{} `type:"structure"` @@ -29787,6 +30068,12 @@ const ( // BotRecommendationStatusFailed is a BotRecommendationStatus enum value BotRecommendationStatusFailed = "Failed" + + // BotRecommendationStatusStopping is a BotRecommendationStatus enum value + BotRecommendationStatusStopping = "Stopping" + + // BotRecommendationStatusStopped is a BotRecommendationStatus enum value + BotRecommendationStatusStopped = "Stopped" ) // BotRecommendationStatus_Values returns all elements of the BotRecommendationStatus enum @@ -29799,6 +30086,8 @@ func BotRecommendationStatus_Values() []string { BotRecommendationStatusUpdating, BotRecommendationStatusAvailable, BotRecommendationStatusFailed, + BotRecommendationStatusStopping, + BotRecommendationStatusStopped, } } diff --git a/service/lexmodelsv2/lexmodelsv2iface/interface.go b/service/lexmodelsv2/lexmodelsv2iface/interface.go index 20fd1c001e..2595af81c6 100644 --- a/service/lexmodelsv2/lexmodelsv2iface/interface.go +++ b/service/lexmodelsv2/lexmodelsv2iface/interface.go @@ -322,6 +322,10 @@ type LexModelsV2API interface { StartImportWithContext(aws.Context, *lexmodelsv2.StartImportInput, ...request.Option) (*lexmodelsv2.StartImportOutput, error) StartImportRequest(*lexmodelsv2.StartImportInput) (*request.Request, *lexmodelsv2.StartImportOutput) + StopBotRecommendation(*lexmodelsv2.StopBotRecommendationInput) (*lexmodelsv2.StopBotRecommendationOutput, error) + StopBotRecommendationWithContext(aws.Context, *lexmodelsv2.StopBotRecommendationInput, ...request.Option) (*lexmodelsv2.StopBotRecommendationOutput, error) + StopBotRecommendationRequest(*lexmodelsv2.StopBotRecommendationInput) (*request.Request, *lexmodelsv2.StopBotRecommendationOutput) + TagResource(*lexmodelsv2.TagResourceInput) (*lexmodelsv2.TagResourceOutput, error) TagResourceWithContext(aws.Context, *lexmodelsv2.TagResourceInput, ...request.Option) (*lexmodelsv2.TagResourceOutput, error) TagResourceRequest(*lexmodelsv2.TagResourceInput) (*request.Request, *lexmodelsv2.TagResourceOutput) diff --git a/service/securityhub/api.go b/service/securityhub/api.go index 6b5993d2cc..27ea2ff8c0 100644 --- a/service/securityhub/api.go +++ b/service/securityhub/api.go @@ -8223,7 +8223,7 @@ type AwsAutoScalingAutoScalingGroupDetails struct { // it checks the health status of an EC2 instance that has come into service. HealthCheckGracePeriod *int64 `type:"integer"` - // The service to use for the health checks. + // The service to use for the health checks. Valid values are EC2 or ELB. HealthCheckType *string `type:"string"` // The name of the launch configuration. @@ -8413,7 +8413,8 @@ func (s *AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails) SetLaunchTem type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails struct { _ struct{} `type:"structure"` - // How to allocate instance types to fulfill On-Demand capacity. + // How to allocate instance types to fulfill On-Demand capacity. The valid value + // is prioritized. OnDemandAllocationStrategy *string `type:"string"` // The minimum amount of the Auto Scaling group's capacity that must be fulfilled @@ -8424,7 +8425,14 @@ type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDeta // beyond OnDemandBaseCapacity. OnDemandPercentageAboveBaseCapacity *int64 `type:"integer"` - // How to allocate instances across Spot Instance pools. + // How to allocate instances across Spot Instance pools. Valid values are as + // follows: + // + // * lowest-price + // + // * capacity-optimized + // + // * capacity-optimized-prioritized SpotAllocationStrategy *string `type:"string"` // The number of Spot Instance pools across which to allocate your Spot Instances. @@ -8730,7 +8738,19 @@ type AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails struct { // the snapshot. VolumeSize *int64 `type:"integer"` - // The volume type. + // The volume type. Valid values are as follows: + // + // * gp2 + // + // * gp3 + // + // * io1 + // + // * sc1 + // + // * st1 + // + // * standard VolumeType *string `type:"string"` } @@ -9081,6 +9101,892 @@ func (s *AwsAutoScalingLaunchConfigurationMetadataOptions) SetHttpTokens(v strin return s } +// Provides a list of backup options for each resource type. +type AwsBackupBackupPlanAdvancedBackupSettingsDetails struct { + _ struct{} `type:"structure"` + + // Specifies the backup option for a selected resource. This option is only + // available for Windows Volume Shadow Copy Service (VSS) backup jobs. Valid + // values are as follows: + // + // * Set to WindowsVSS: enabled to enable the WindowsVSS backup option and + // create a Windows VSS backup. + // + // * Set to WindowsVSS: disabled to create a regular backup. The WindowsVSS + // option is not enabled by default. + BackupOptions map[string]*string `type:"map"` + + // The name of a resource type. The only supported resource type is Amazon EC2 + // instances with Windows VSS. + // + // The only valid value is EC2. + ResourceType *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 AwsBackupBackupPlanAdvancedBackupSettingsDetails) 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 AwsBackupBackupPlanAdvancedBackupSettingsDetails) GoString() string { + return s.String() +} + +// SetBackupOptions sets the BackupOptions field's value. +func (s *AwsBackupBackupPlanAdvancedBackupSettingsDetails) SetBackupOptions(v map[string]*string) *AwsBackupBackupPlanAdvancedBackupSettingsDetails { + s.BackupOptions = v + return s +} + +// SetResourceType sets the ResourceType field's value. +func (s *AwsBackupBackupPlanAdvancedBackupSettingsDetails) SetResourceType(v string) *AwsBackupBackupPlanAdvancedBackupSettingsDetails { + s.ResourceType = &v + return s +} + +// Provides details about an Backup backup plan and an array of BackupRule objects, +// each of which specifies a backup rule. +type AwsBackupBackupPlanBackupPlanDetails struct { + _ struct{} `type:"structure"` + + // A list of backup options for each resource type. + AdvancedBackupSettings []*AwsBackupBackupPlanAdvancedBackupSettingsDetails `type:"list"` + + // The display name of a backup plan. + BackupPlanName *string `type:"string"` + + // An array of BackupRule objects, each of which specifies a scheduled task + // that is used to back up a selection of resources. + BackupPlanRule []*AwsBackupBackupPlanRuleDetails `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 AwsBackupBackupPlanBackupPlanDetails) 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 AwsBackupBackupPlanBackupPlanDetails) GoString() string { + return s.String() +} + +// SetAdvancedBackupSettings sets the AdvancedBackupSettings field's value. +func (s *AwsBackupBackupPlanBackupPlanDetails) SetAdvancedBackupSettings(v []*AwsBackupBackupPlanAdvancedBackupSettingsDetails) *AwsBackupBackupPlanBackupPlanDetails { + s.AdvancedBackupSettings = v + return s +} + +// SetBackupPlanName sets the BackupPlanName field's value. +func (s *AwsBackupBackupPlanBackupPlanDetails) SetBackupPlanName(v string) *AwsBackupBackupPlanBackupPlanDetails { + s.BackupPlanName = &v + return s +} + +// SetBackupPlanRule sets the BackupPlanRule field's value. +func (s *AwsBackupBackupPlanBackupPlanDetails) SetBackupPlanRule(v []*AwsBackupBackupPlanRuleDetails) *AwsBackupBackupPlanBackupPlanDetails { + s.BackupPlanRule = v + return s +} + +// Provides details about an Backup backup plan and an array of BackupRule objects, +// each of which specifies a backup rule. +type AwsBackupBackupPlanDetails struct { + _ struct{} `type:"structure"` + + // Uniquely identifies the backup plan to be associated with the selection of + // resources. + BackupPlan *AwsBackupBackupPlanBackupPlanDetails `type:"structure"` + + // An Amazon Resource Name (ARN) that uniquely identifies the backup plan. + BackupPlanArn *string `type:"string"` + + // A unique ID for the backup plan. + BackupPlanId *string `type:"string"` + + // Unique, randomly generated, Unicode, UTF-8 encoded strings. Version IDs cannot + // be edited. + VersionId *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 AwsBackupBackupPlanDetails) 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 AwsBackupBackupPlanDetails) GoString() string { + return s.String() +} + +// SetBackupPlan sets the BackupPlan field's value. +func (s *AwsBackupBackupPlanDetails) SetBackupPlan(v *AwsBackupBackupPlanBackupPlanDetails) *AwsBackupBackupPlanDetails { + s.BackupPlan = v + return s +} + +// SetBackupPlanArn sets the BackupPlanArn field's value. +func (s *AwsBackupBackupPlanDetails) SetBackupPlanArn(v string) *AwsBackupBackupPlanDetails { + s.BackupPlanArn = &v + return s +} + +// SetBackupPlanId sets the BackupPlanId field's value. +func (s *AwsBackupBackupPlanDetails) SetBackupPlanId(v string) *AwsBackupBackupPlanDetails { + s.BackupPlanId = &v + return s +} + +// SetVersionId sets the VersionId field's value. +func (s *AwsBackupBackupPlanDetails) SetVersionId(v string) *AwsBackupBackupPlanDetails { + s.VersionId = &v + return s +} + +// Provides lifecycle details for the backup plan. A lifecycle defines when +// a backup is transitioned to cold storage and when it expires. +type AwsBackupBackupPlanLifecycleDetails struct { + _ struct{} `type:"structure"` + + // Specifies the number of days after creation that a recovery point is deleted. + // Must be greater than 90 days plus MoveToColdStorageAfterDays. + DeleteAfterDays *int64 `type:"long"` + + // Specifies the number of days after creation that a recovery point is moved + // to cold storage. + MoveToColdStorageAfterDays *int64 `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 AwsBackupBackupPlanLifecycleDetails) 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 AwsBackupBackupPlanLifecycleDetails) GoString() string { + return s.String() +} + +// SetDeleteAfterDays sets the DeleteAfterDays field's value. +func (s *AwsBackupBackupPlanLifecycleDetails) SetDeleteAfterDays(v int64) *AwsBackupBackupPlanLifecycleDetails { + s.DeleteAfterDays = &v + return s +} + +// SetMoveToColdStorageAfterDays sets the MoveToColdStorageAfterDays field's value. +func (s *AwsBackupBackupPlanLifecycleDetails) SetMoveToColdStorageAfterDays(v int64) *AwsBackupBackupPlanLifecycleDetails { + s.MoveToColdStorageAfterDays = &v + return s +} + +// An array of CopyAction objects, which contains the details of the copy operation. +type AwsBackupBackupPlanRuleCopyActionsDetails struct { + _ struct{} `type:"structure"` + + // An Amazon Resource Name (ARN) that uniquely identifies the destination backup + // vault for the copied backup. + DestinationBackupVaultArn *string `type:"string"` + + // Defines when a protected resource is transitioned to cold storage and when + // it expires. Backup transitions and expires backups automatically according + // to the lifecycle that you define. If you do not specify a lifecycle, Backup + // applies the lifecycle policy of the source backup to the destination backup. + // + // Backups transitioned to cold storage must be stored in cold storage for a + // minimum of 90 days. + Lifecycle *AwsBackupBackupPlanLifecycleDetails `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 AwsBackupBackupPlanRuleCopyActionsDetails) 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 AwsBackupBackupPlanRuleCopyActionsDetails) GoString() string { + return s.String() +} + +// SetDestinationBackupVaultArn sets the DestinationBackupVaultArn field's value. +func (s *AwsBackupBackupPlanRuleCopyActionsDetails) SetDestinationBackupVaultArn(v string) *AwsBackupBackupPlanRuleCopyActionsDetails { + s.DestinationBackupVaultArn = &v + return s +} + +// SetLifecycle sets the Lifecycle field's value. +func (s *AwsBackupBackupPlanRuleCopyActionsDetails) SetLifecycle(v *AwsBackupBackupPlanLifecycleDetails) *AwsBackupBackupPlanRuleCopyActionsDetails { + s.Lifecycle = v + return s +} + +// Provides details about an array of BackupRule objects, each of which specifies +// a scheduled task that is used to back up a selection of resources. +type AwsBackupBackupPlanRuleDetails struct { + _ struct{} `type:"structure"` + + // A value in minutes after a backup job is successfully started before it must + // be completed, or it is canceled by Backup. + CompletionWindowMinutes *int64 `type:"long"` + + // An array of CopyAction objects, which contains the details of the copy operation. + CopyActions []*AwsBackupBackupPlanRuleCopyActionsDetails `type:"list"` + + // Specifies whether Backup creates continuous backups capable of point-in-time + // restore (PITR). + EnableContinuousBackup *bool `type:"boolean"` + + // Defines when a protected resource is transitioned to cold storage and when + // it expires. Backup transitions and expires backups automatically according + // to the lifecycle that you define. If you do not specify a lifecycle, Backup + // applies the lifecycle policy of the source backup to the destination backup. + // + // Backups transitioned to cold storage must be stored in cold storage for a + // minimum of 90 days. + Lifecycle *AwsBackupBackupPlanLifecycleDetails `type:"structure"` + + // Uniquely identifies a rule that is used to schedule the backup of a selection + // of resources. + RuleId *string `type:"string"` + + // A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' + // characters. + RuleName *string `type:"string"` + + // A cron expression in UTC specifying when Backup initiates a backup job. + ScheduleExpression *string `type:"string"` + + // A value in minutes after a backup is scheduled before a job will be canceled + // if it doesn't start successfully. + StartWindowMinutes *int64 `type:"long"` + + // The name of a logical container where backups are stored. Backup vaults are + // identified by names that are unique to the Amazon Web Services account used + // to create them and the Amazon Web Services Region where they are created. + // They consist of letters, numbers, and hyphens. + TargetBackupVault *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 AwsBackupBackupPlanRuleDetails) 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 AwsBackupBackupPlanRuleDetails) GoString() string { + return s.String() +} + +// SetCompletionWindowMinutes sets the CompletionWindowMinutes field's value. +func (s *AwsBackupBackupPlanRuleDetails) SetCompletionWindowMinutes(v int64) *AwsBackupBackupPlanRuleDetails { + s.CompletionWindowMinutes = &v + return s +} + +// SetCopyActions sets the CopyActions field's value. +func (s *AwsBackupBackupPlanRuleDetails) SetCopyActions(v []*AwsBackupBackupPlanRuleCopyActionsDetails) *AwsBackupBackupPlanRuleDetails { + s.CopyActions = v + return s +} + +// SetEnableContinuousBackup sets the EnableContinuousBackup field's value. +func (s *AwsBackupBackupPlanRuleDetails) SetEnableContinuousBackup(v bool) *AwsBackupBackupPlanRuleDetails { + s.EnableContinuousBackup = &v + return s +} + +// SetLifecycle sets the Lifecycle field's value. +func (s *AwsBackupBackupPlanRuleDetails) SetLifecycle(v *AwsBackupBackupPlanLifecycleDetails) *AwsBackupBackupPlanRuleDetails { + s.Lifecycle = v + return s +} + +// SetRuleId sets the RuleId field's value. +func (s *AwsBackupBackupPlanRuleDetails) SetRuleId(v string) *AwsBackupBackupPlanRuleDetails { + s.RuleId = &v + return s +} + +// SetRuleName sets the RuleName field's value. +func (s *AwsBackupBackupPlanRuleDetails) SetRuleName(v string) *AwsBackupBackupPlanRuleDetails { + s.RuleName = &v + return s +} + +// SetScheduleExpression sets the ScheduleExpression field's value. +func (s *AwsBackupBackupPlanRuleDetails) SetScheduleExpression(v string) *AwsBackupBackupPlanRuleDetails { + s.ScheduleExpression = &v + return s +} + +// SetStartWindowMinutes sets the StartWindowMinutes field's value. +func (s *AwsBackupBackupPlanRuleDetails) SetStartWindowMinutes(v int64) *AwsBackupBackupPlanRuleDetails { + s.StartWindowMinutes = &v + return s +} + +// SetTargetBackupVault sets the TargetBackupVault field's value. +func (s *AwsBackupBackupPlanRuleDetails) SetTargetBackupVault(v string) *AwsBackupBackupPlanRuleDetails { + s.TargetBackupVault = &v + return s +} + +// Provides details about an Backup backup vault. In Backup, a backup vault +// is a container that stores and organizes your backups. +type AwsBackupBackupVaultDetails struct { + _ struct{} `type:"structure"` + + // A resource-based policy that is used to manage access permissions on the + // target backup vault. + AccessPolicy *string `type:"string"` + + // An Amazon Resource Name (ARN) that uniquely identifies a backup vault. + BackupVaultArn *string `type:"string"` + + // The name of a logical container where backups are stored. Backup vaults are + // identified by names that are unique to the Amazon Web Services account used + // to create them and the Amazon Web Services Region where they are created. + // They consist of lowercase letters, numbers, and hyphens. + BackupVaultName *string `type:"string"` + + // The unique ARN associated with the server-side encryption key. You can specify + // a key to encrypt your backups from services that support full Backup management. + // If you do not specify a key, Backup creates an KMS key for you by default. + EncryptionKeyArn *string `type:"string"` + + // The Amazon SNS event notifications for the specified backup vault. + Notifications *AwsBackupBackupVaultNotificationsDetails `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 AwsBackupBackupVaultDetails) 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 AwsBackupBackupVaultDetails) GoString() string { + return s.String() +} + +// SetAccessPolicy sets the AccessPolicy field's value. +func (s *AwsBackupBackupVaultDetails) SetAccessPolicy(v string) *AwsBackupBackupVaultDetails { + s.AccessPolicy = &v + return s +} + +// SetBackupVaultArn sets the BackupVaultArn field's value. +func (s *AwsBackupBackupVaultDetails) SetBackupVaultArn(v string) *AwsBackupBackupVaultDetails { + s.BackupVaultArn = &v + return s +} + +// SetBackupVaultName sets the BackupVaultName field's value. +func (s *AwsBackupBackupVaultDetails) SetBackupVaultName(v string) *AwsBackupBackupVaultDetails { + s.BackupVaultName = &v + return s +} + +// SetEncryptionKeyArn sets the EncryptionKeyArn field's value. +func (s *AwsBackupBackupVaultDetails) SetEncryptionKeyArn(v string) *AwsBackupBackupVaultDetails { + s.EncryptionKeyArn = &v + return s +} + +// SetNotifications sets the Notifications field's value. +func (s *AwsBackupBackupVaultDetails) SetNotifications(v *AwsBackupBackupVaultNotificationsDetails) *AwsBackupBackupVaultDetails { + s.Notifications = v + return s +} + +// Provides details about the Amazon SNS event notifications for the specified +// backup vault. +type AwsBackupBackupVaultNotificationsDetails struct { + _ struct{} `type:"structure"` + + // An array of events that indicate the status of jobs to back up resources + // to the backup vault. The following events are supported: + // + // * BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED + // + // * COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED + // + // * RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED + // + // * S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED + BackupVaultEvents []*string `type:"list"` + + // An ARN that uniquely identifies the Amazon SNS topic for a backup vault’s + // events. + SnsTopicArn *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 AwsBackupBackupVaultNotificationsDetails) 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 AwsBackupBackupVaultNotificationsDetails) GoString() string { + return s.String() +} + +// SetBackupVaultEvents sets the BackupVaultEvents field's value. +func (s *AwsBackupBackupVaultNotificationsDetails) SetBackupVaultEvents(v []*string) *AwsBackupBackupVaultNotificationsDetails { + s.BackupVaultEvents = v + return s +} + +// SetSnsTopicArn sets the SnsTopicArn field's value. +func (s *AwsBackupBackupVaultNotificationsDetails) SetSnsTopicArn(v string) *AwsBackupBackupVaultNotificationsDetails { + s.SnsTopicArn = &v + return s +} + +// Specifies how long in days before a recovery point transitions to cold storage +// or is deleted. +type AwsBackupRecoveryPointCalculatedLifecycleDetails struct { + _ struct{} `type:"structure"` + + // Specifies the number of days after creation that a recovery point is deleted. + // Must be greater than 90 days plus MoveToColdStorageAfterDays. + DeleteAt *string `type:"string"` + + // Specifies the number of days after creation that a recovery point is moved + // to cold storage. + MoveToColdStorageAt *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 AwsBackupRecoveryPointCalculatedLifecycleDetails) 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 AwsBackupRecoveryPointCalculatedLifecycleDetails) GoString() string { + return s.String() +} + +// SetDeleteAt sets the DeleteAt field's value. +func (s *AwsBackupRecoveryPointCalculatedLifecycleDetails) SetDeleteAt(v string) *AwsBackupRecoveryPointCalculatedLifecycleDetails { + s.DeleteAt = &v + return s +} + +// SetMoveToColdStorageAt sets the MoveToColdStorageAt field's value. +func (s *AwsBackupRecoveryPointCalculatedLifecycleDetails) SetMoveToColdStorageAt(v string) *AwsBackupRecoveryPointCalculatedLifecycleDetails { + s.MoveToColdStorageAt = &v + return s +} + +// Contains information about the backup plan and rule that Backup used to initiate +// the recovery point backup. +type AwsBackupRecoveryPointCreatedByDetails struct { + _ struct{} `type:"structure"` + + // An Amazon Resource Name (ARN) that uniquely identifies a backup plan. + BackupPlanArn *string `type:"string"` + + // Uniquely identifies a backup plan. + BackupPlanId *string `type:"string"` + + // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most + // 1,024 bytes long. Version IDs cannot be edited. + BackupPlanVersion *string `type:"string"` + + // Uniquely identifies a rule used to schedule the backup of a selection of + // resources. + BackupRuleId *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 AwsBackupRecoveryPointCreatedByDetails) 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 AwsBackupRecoveryPointCreatedByDetails) GoString() string { + return s.String() +} + +// SetBackupPlanArn sets the BackupPlanArn field's value. +func (s *AwsBackupRecoveryPointCreatedByDetails) SetBackupPlanArn(v string) *AwsBackupRecoveryPointCreatedByDetails { + s.BackupPlanArn = &v + return s +} + +// SetBackupPlanId sets the BackupPlanId field's value. +func (s *AwsBackupRecoveryPointCreatedByDetails) SetBackupPlanId(v string) *AwsBackupRecoveryPointCreatedByDetails { + s.BackupPlanId = &v + return s +} + +// SetBackupPlanVersion sets the BackupPlanVersion field's value. +func (s *AwsBackupRecoveryPointCreatedByDetails) SetBackupPlanVersion(v string) *AwsBackupRecoveryPointCreatedByDetails { + s.BackupPlanVersion = &v + return s +} + +// SetBackupRuleId sets the BackupRuleId field's value. +func (s *AwsBackupRecoveryPointCreatedByDetails) SetBackupRuleId(v string) *AwsBackupRecoveryPointCreatedByDetails { + s.BackupRuleId = &v + return s +} + +// Contains detailed information about the recovery points stored in an Backup +// backup vault. A backup, or recovery point, represents the content of a resource +// at a specified time. +type AwsBackupRecoveryPointDetails struct { + _ struct{} `type:"structure"` + + // The size, in bytes, of a backup. + BackupSizeInBytes *int64 `type:"long"` + + // An Amazon Resource Name (ARN) that uniquely identifies a backup vault. + BackupVaultArn *string `type:"string"` + + // The name of a logical container where backups are stored. Backup vaults are + // identified by names that are unique to the Amazon Web Services account used + // to create them and the Amazon Web Services Region where they are created. + // They consist of lowercase letters, numbers, and hyphens. + BackupVaultName *string `type:"string"` + + // A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt + // timestamps. + CalculatedLifecycle *AwsBackupRecoveryPointCalculatedLifecycleDetails `type:"structure"` + + // The date and time that a job to create a recovery point is completed, in + // Unix format and UTC. The value of CompletionDate is accurate to milliseconds. + // For example, the value 1516925490.087 represents Friday, January 26, 2018 + // 12:11:30.087 AM. + CompletionDate *string `type:"string"` + + // Contains identifying information about the creation of a recovery point, + // including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId + // of the backup plan that is used to create it. + CreatedBy *AwsBackupRecoveryPointCreatedByDetails `type:"structure"` + + // The date and time a recovery point is created, in Unix format and UTC. The + // value of CreationDate is accurate to milliseconds. For example, the value + // 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. + CreationDate *string `type:"string"` + + // The ARN for the server-side encryption key that is used to protect your backups. + EncryptionKeyArn *string `type:"string"` + + // Specifies the IAM role ARN used to create the target recovery point + IamRoleArn *string `type:"string"` + + // A Boolean value that is returned as TRUE if the specified recovery point + // is encrypted, or FALSE if the recovery point is not encrypted. + IsEncrypted *bool `type:"boolean"` + + // The date and time that a recovery point was last restored, in Unix format + // and UTC. The value of LastRestoreTime is accurate to milliseconds. For example, + // the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 + // AM. + LastRestoreTime *string `type:"string"` + + // The lifecycle defines when a protected resource is transitioned to cold storage + // and when it expires. Backup transitions and expires backups automatically + // according to the lifecycle that you define + Lifecycle *AwsBackupRecoveryPointLifecycleDetails `type:"structure"` + + // An ARN that uniquely identifies a recovery point. + RecoveryPointArn *string `type:"string"` + + // An ARN that uniquely identifies a resource. The format of the ARN depends + // on the resource type. + ResourceArn *string `type:"string"` + + // The type of Amazon Web Services resource saved as a recovery point, such + // as an Amazon EBS volume or an Amazon RDS database. + ResourceType *string `type:"string"` + + // The ARN for the backup vault where the recovery point was originally copied + // from. If the recovery point is restored to the same account, this value will + // be null. + SourceBackupVaultArn *string `type:"string"` + + // A status code specifying the state of the recovery point. Valid values are + // as follows: + // + // * COMPLETED + // + // * DELETING + // + // * EXPIRED + // + // * PARTIAL + Status *string `type:"string"` + + // A message explaining the reason of the recovery point deletion failure. + StatusMessage *string `type:"string"` + + // Specifies the storage class of the recovery point. Valid values are as follows: + // + // * COLD + // + // * DELETED + // + // * WARM + StorageClass *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 AwsBackupRecoveryPointDetails) 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 AwsBackupRecoveryPointDetails) GoString() string { + return s.String() +} + +// SetBackupSizeInBytes sets the BackupSizeInBytes field's value. +func (s *AwsBackupRecoveryPointDetails) SetBackupSizeInBytes(v int64) *AwsBackupRecoveryPointDetails { + s.BackupSizeInBytes = &v + return s +} + +// SetBackupVaultArn sets the BackupVaultArn field's value. +func (s *AwsBackupRecoveryPointDetails) SetBackupVaultArn(v string) *AwsBackupRecoveryPointDetails { + s.BackupVaultArn = &v + return s +} + +// SetBackupVaultName sets the BackupVaultName field's value. +func (s *AwsBackupRecoveryPointDetails) SetBackupVaultName(v string) *AwsBackupRecoveryPointDetails { + s.BackupVaultName = &v + return s +} + +// SetCalculatedLifecycle sets the CalculatedLifecycle field's value. +func (s *AwsBackupRecoveryPointDetails) SetCalculatedLifecycle(v *AwsBackupRecoveryPointCalculatedLifecycleDetails) *AwsBackupRecoveryPointDetails { + s.CalculatedLifecycle = v + return s +} + +// SetCompletionDate sets the CompletionDate field's value. +func (s *AwsBackupRecoveryPointDetails) SetCompletionDate(v string) *AwsBackupRecoveryPointDetails { + s.CompletionDate = &v + return s +} + +// SetCreatedBy sets the CreatedBy field's value. +func (s *AwsBackupRecoveryPointDetails) SetCreatedBy(v *AwsBackupRecoveryPointCreatedByDetails) *AwsBackupRecoveryPointDetails { + s.CreatedBy = v + return s +} + +// SetCreationDate sets the CreationDate field's value. +func (s *AwsBackupRecoveryPointDetails) SetCreationDate(v string) *AwsBackupRecoveryPointDetails { + s.CreationDate = &v + return s +} + +// SetEncryptionKeyArn sets the EncryptionKeyArn field's value. +func (s *AwsBackupRecoveryPointDetails) SetEncryptionKeyArn(v string) *AwsBackupRecoveryPointDetails { + s.EncryptionKeyArn = &v + return s +} + +// SetIamRoleArn sets the IamRoleArn field's value. +func (s *AwsBackupRecoveryPointDetails) SetIamRoleArn(v string) *AwsBackupRecoveryPointDetails { + s.IamRoleArn = &v + return s +} + +// SetIsEncrypted sets the IsEncrypted field's value. +func (s *AwsBackupRecoveryPointDetails) SetIsEncrypted(v bool) *AwsBackupRecoveryPointDetails { + s.IsEncrypted = &v + return s +} + +// SetLastRestoreTime sets the LastRestoreTime field's value. +func (s *AwsBackupRecoveryPointDetails) SetLastRestoreTime(v string) *AwsBackupRecoveryPointDetails { + s.LastRestoreTime = &v + return s +} + +// SetLifecycle sets the Lifecycle field's value. +func (s *AwsBackupRecoveryPointDetails) SetLifecycle(v *AwsBackupRecoveryPointLifecycleDetails) *AwsBackupRecoveryPointDetails { + s.Lifecycle = v + return s +} + +// SetRecoveryPointArn sets the RecoveryPointArn field's value. +func (s *AwsBackupRecoveryPointDetails) SetRecoveryPointArn(v string) *AwsBackupRecoveryPointDetails { + s.RecoveryPointArn = &v + return s +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *AwsBackupRecoveryPointDetails) SetResourceArn(v string) *AwsBackupRecoveryPointDetails { + s.ResourceArn = &v + return s +} + +// SetResourceType sets the ResourceType field's value. +func (s *AwsBackupRecoveryPointDetails) SetResourceType(v string) *AwsBackupRecoveryPointDetails { + s.ResourceType = &v + return s +} + +// SetSourceBackupVaultArn sets the SourceBackupVaultArn field's value. +func (s *AwsBackupRecoveryPointDetails) SetSourceBackupVaultArn(v string) *AwsBackupRecoveryPointDetails { + s.SourceBackupVaultArn = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *AwsBackupRecoveryPointDetails) SetStatus(v string) *AwsBackupRecoveryPointDetails { + s.Status = &v + return s +} + +// SetStatusMessage sets the StatusMessage field's value. +func (s *AwsBackupRecoveryPointDetails) SetStatusMessage(v string) *AwsBackupRecoveryPointDetails { + s.StatusMessage = &v + return s +} + +// SetStorageClass sets the StorageClass field's value. +func (s *AwsBackupRecoveryPointDetails) SetStorageClass(v string) *AwsBackupRecoveryPointDetails { + s.StorageClass = &v + return s +} + +// Contains an array of Transition objects specifying how long in days before +// a recovery point transitions to cold storage or is deleted. +type AwsBackupRecoveryPointLifecycleDetails struct { + _ struct{} `type:"structure"` + + // Specifies the number of days after creation that a recovery point is deleted. + // Must be greater than 90 days plus MoveToColdStorageAfterDays. + DeleteAfterDays *int64 `type:"long"` + + // Specifies the number of days after creation that a recovery point is moved + // to cold storage. + MoveToColdStorageAfterDays *int64 `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 AwsBackupRecoveryPointLifecycleDetails) 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 AwsBackupRecoveryPointLifecycleDetails) GoString() string { + return s.String() +} + +// SetDeleteAfterDays sets the DeleteAfterDays field's value. +func (s *AwsBackupRecoveryPointLifecycleDetails) SetDeleteAfterDays(v int64) *AwsBackupRecoveryPointLifecycleDetails { + s.DeleteAfterDays = &v + return s +} + +// SetMoveToColdStorageAfterDays sets the MoveToColdStorageAfterDays field's value. +func (s *AwsBackupRecoveryPointLifecycleDetails) SetMoveToColdStorageAfterDays(v int64) *AwsBackupRecoveryPointLifecycleDetails { + s.MoveToColdStorageAfterDays = &v + return s +} + // Provides details about an Certificate Manager certificate. type AwsCertificateManagerCertificateDetails struct { _ struct{} `type:"structure"` @@ -9576,7 +10482,8 @@ type AwsCertificateManagerCertificateRenewalSummary struct { // Valid values: PENDING_AUTO_RENEWAL | PENDING_VALIDATION | SUCCESS | FAILED RenewalStatus *string `type:"string"` - // The reason that a renewal request was unsuccessful. + // The reason that a renewal request was unsuccessful. This attribute is used + // only when RenewalStatus is FAILED. // // Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | // DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR @@ -12142,7 +13049,21 @@ type AwsDynamoDbTableDetails struct { // The total size of the table in bytes. TableSizeBytes *int64 `type:"long"` - // The current status of the table. + // The current status of the table. Valid values are as follows: + // + // * ACTIVE + // + // * ARCHIVED + // + // * ARCHIVING + // + // * CREATING + // + // * DELETING + // + // * INACCESSIBLE_ENCRYPTION_CREDENTIALS + // + // * UPDATING TableStatus *string `type:"string"` } @@ -12295,6 +13216,14 @@ type AwsDynamoDbTableGlobalSecondaryIndex struct { IndexSizeBytes *int64 `type:"long"` // The current status of the index. + // + // * ACTIVE + // + // * CREATING + // + // * DELETING + // + // * UPDATING IndexStatus *string `type:"string"` // The number of items in the index. @@ -12390,7 +13319,8 @@ type AwsDynamoDbTableKeySchema struct { // The name of the key schema attribute. AttributeName *string `type:"string"` - // The type of key used for the key schema attribute. + // The type of key used for the key schema attribute. Valid values are HASH + // or RANGE. KeyType *string `type:"string"` } @@ -12494,7 +13424,14 @@ type AwsDynamoDbTableProjection struct { // provide the attribute name. NonKeyAttributes []*string `type:"list"` - // The types of attributes that are projected into the index. + // The types of attributes that are projected into the index. Valid values are + // as follows: + // + // * ALL + // + // * INCLUDE + // + // * KEYS_ONLY ProjectionType *string `type:"string"` } @@ -12657,7 +13594,17 @@ type AwsDynamoDbTableReplica struct { // The name of the Region where the replica is located. RegionName *string `type:"string"` - // The current status of the replica. + // The current status of the replica. Valid values are as follows: + // + // * ACTIVE + // + // * CREATING + // + // * CREATION_FAILED + // + // * DELETING + // + // * UPDATING ReplicaStatus *string `type:"string"` // Detailed information about the replica status. @@ -14216,7 +15163,7 @@ type AwsEc2SubnetDetails struct { // The identifier of the Amazon Web Services account that owns the subnet. OwnerId *string `type:"string"` - // The current state of the subnet. + // The current state of the subnet. Valid values are available or pending. State *string `type:"string"` // The ARN of the subnet. @@ -14472,7 +15419,17 @@ type AwsEc2VolumeAttachment struct { // The identifier of the EC2 instance. InstanceId *string `type:"string"` - // The attachment state of the volume. + // The attachment state of the volume. Valid values are as follows: + // + // * attaching + // + // * attached + // + // * busy + // + // * detaching + // + // * detached Status *string `type:"string"` } @@ -14548,7 +15505,19 @@ type AwsEc2VolumeDetails struct { // The snapshot from which the volume was created. SnapshotId *string `type:"string"` - // The volume state. + // The volume state. Valid values are as follows: + // + // * available + // + // * creating + // + // * deleted + // + // * deleting + // + // * error + // + // * in-use Status *string `type:"string"` // The ID of the volume. @@ -14660,7 +15629,7 @@ type AwsEc2VpcDetails struct { // Information about the IPv6 CIDR blocks associated with the VPC. Ipv6CidrBlockAssociationSet []*Ipv6CidrBlockAssociation `type:"list"` - // The current state of the VPC. + // The current state of the VPC. Valid values are available or pending. State *string `type:"string"` } @@ -14738,7 +15707,17 @@ type AwsEc2VpcEndpointServiceDetails struct { // The name of the service. ServiceName *string `type:"string"` - // The current state of the service. + // The current state of the service. Valid values are as follows: + // + // * Available + // + // * Deleted + // + // * Deleting + // + // * Failed + // + // * Pending ServiceState *string `type:"string"` // The types for the service. @@ -15080,7 +16059,15 @@ type AwsEc2VpnConnectionDetails struct { // The static routes that are associated with the VPN connection. Routes []*AwsEc2VpnConnectionRoutesDetails `type:"list"` - // The current state of the VPN connection. + // The current state of the VPN connection. Valid values are as follows: + // + // * available + // + // * deleted + // + // * deleting + // + // * pending State *string `type:"string"` // The identifier of the transit gateway that is associated with the VPN connection. @@ -15460,7 +16447,7 @@ type AwsEc2VpnConnectionVgwTelemetryDetails struct { // interface. OutsideIpAddress *string `type:"string"` - // The status of the VPN tunnel. + // The status of the VPN tunnel. Valid values are DOWN or UP. Status *string `type:"string"` // If an error occurs, a description of the error. @@ -15525,7 +16512,13 @@ func (s *AwsEc2VpnConnectionVgwTelemetryDetails) SetStatusMessage(v string) *Aws type AwsEcrContainerImageDetails struct { _ struct{} `type:"structure"` - // The architecture of the image. + // The architecture of the image. Valid values are as follows: + // + // * arm64 + // + // * i386 + // + // * x86_64 Architecture *string `type:"string"` // The sha256 digest of the image manifest. @@ -15613,7 +16606,8 @@ type AwsEcrRepositoryDetails struct { // The image scanning configuration for a repository. ImageScanningConfiguration *AwsEcrRepositoryImageScanningConfigurationDetails `type:"structure"` - // The tag mutability setting for the repository. + // The tag mutability setting for the repository. Valid values are IMMUTABLE + // or MUTABLE. ImageTagMutability *string `type:"string"` // Information about the lifecycle policy for the repository. @@ -15758,10 +16752,10 @@ func (s *AwsEcrRepositoryLifecyclePolicyDetails) SetRegistryId(v string) *AwsEcr type AwsEcsClusterClusterSettingsDetails struct { _ struct{} `type:"structure"` - // The name of the setting. + // The name of the setting. The valid value is containerInsights. Name *string `type:"string"` - // The value of the setting. + // The value of the setting. Valid values are disabled or enabled. Value *string `type:"string"` } @@ -16995,6 +17989,15 @@ type AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails struct { // The dependency condition of the dependent container. Indicates the required // status of the dependent container before the current container can start. + // Valid values are as follows: + // + // * COMPLETE + // + // * HEALTHY + // + // * SUCCESS + // + // * START Condition *string `type:"string"` // The name of the dependent container. @@ -17479,7 +18482,7 @@ func (s *AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails) SetValue(v type AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails struct { _ struct{} `type:"structure"` - // The type of environment file. + // The type of environment file. The valid value is s3. Type *string `type:"string"` // The ARN of the S3 object that contains the environment variable file. @@ -17574,7 +18577,7 @@ type AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails struct // * config-file-value. The value is either an S3 ARN or a file path. Options map[string]*string `type:"map"` - // The log router to use. + // The log router to use. Valid values are fluentbit or fluentd. Type *string `type:"string"` } @@ -17687,11 +18690,29 @@ type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails _ struct{} `type:"structure"` // The Linux capabilities for the container that are added to the default configuration - // provided by Docker. + // provided by Docker. Valid values are as follows: + // + // Valid values: "ALL" | "AUDIT_CONTROL" |"AUDIT_WRITE" | "BLOCK_SUSPEND" | + // "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" + // | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" |"MAC_OVERRIDE" + // | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" + // | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" + // | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | + // "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | + // "WAKE_ALARM" Add []*string `type:"list"` // The Linux capabilities for the container that are dropped from the default // configuration provided by Docker. + // + // Valid values: "ALL" | "AUDIT_CONTROL" |"AUDIT_WRITE" | "BLOCK_SUSPEND" | + // "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" + // | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" |"MAC_OVERRIDE" + // | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" + // | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" + // | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | + // "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | + // "WAKE_ALARM" Drop []*string `type:"list"` } @@ -17875,6 +18896,13 @@ type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails struct ContainerPath *string `type:"string"` // The list of tmpfs volume mount options. + // + // Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" + // |"exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | + // "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" + // | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" + // | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" + // |"mode" | "uid" | "gid" | "nr_inodes" |"nr_blocks" | "mpol" MountOptions []*string `type:"list"` // The maximum size (in MiB) of the tmpfs volume. @@ -17922,6 +18950,34 @@ type AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails struct { _ struct{} `type:"structure"` // The log driver to use for the container. + // + // Valid values on Fargate are as follows: + // + // * awsfirelens + // + // * awslogs + // + // * splunk + // + // Valid values on Amazon EC2 are as follows: + // + // * awsfirelens + // + // * awslogs + // + // * fluentd + // + // * gelf + // + // * journald + // + // * json-file + // + // * logentries + // + // * splunk + // + // * syslog LogDriver *string `type:"string"` // The configuration options to send to the log driver. Requires version 1.19 @@ -18150,7 +19206,7 @@ func (s *AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails) S type AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails struct { _ struct{} `type:"structure"` - // The type of resource to assign to a container. + // The type of resource to assign to a container. Valid values are GPU or InferenceAccelerator. Type *string `type:"string"` // The value for the specified resource type. @@ -18284,7 +19340,37 @@ type AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails struct { // The hard limit for the ulimit type. HardLimit *int64 `type:"integer"` - // The type of the ulimit. + // The type of the ulimit. Valid values are as follows: + // + // * core + // + // * cpu + // + // * data + // + // * fsize + // + // * locks + // + // * memlock + // + // * msgqueue + // + // * nice + // + // * nofile + // + // * nproc + // + // * rss + // + // * rtprio + // + // * rttime + // + // * sigpending + // + // * stack Name *string `type:"string"` // The soft limit for the ulimit type. @@ -18377,7 +19463,17 @@ type AwsEcsTaskDefinitionDetails struct { // The container definitions that describe the containers that make up the task. ContainerDefinitions []*AwsEcsTaskDefinitionContainerDefinitionsDetails `type:"list"` - // The number of CPU units used by the task. + // The number of CPU units used by the task.Valid values are as follows: + // + // * 256 (.25 vCPU) + // + // * 512 (.5 vCPU) + // + // * 1024 (1 vCPU) + // + // * 2048 (2 vCPU) + // + // * 4096 (4 vCPU) Cpu *string `type:"string"` // The ARN of the task execution role that grants the container agent permission @@ -18390,16 +19486,39 @@ type AwsEcsTaskDefinitionDetails struct { // The Elastic Inference accelerators to use for the containers in the task. InferenceAccelerators []*AwsEcsTaskDefinitionInferenceAcceleratorsDetails `type:"list"` - // The IPC resource namespace to use for the containers in the task. + // The inter-process communication (IPC) resource namespace to use for the containers + // in the task. Valid values are as follows: + // + // * host + // + // * none + // + // * task IpcMode *string `type:"string"` // The amount (in MiB) of memory used by the task. + // + // For tasks that are hosted on Amazon EC2, you can provide a task-level memory + // value or a container-level memory value. For tasks that are hosted on Fargate, + // you must use one of the specified values (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size) + // in the Amazon Elastic Container Service Developer Guide , which determines + // your range of supported values for the Cpu and Memory parameters. Memory *string `type:"string"` - // The Docker networking mode to use for the containers in the task. + // The Docker networking mode to use for the containers in the task. Valid values + // are as follows: + // + // * awsvpc + // + // * bridge + // + // * host + // + // * none NetworkMode *string `type:"string"` - // The process namespace to use for the containers in the task. + // The process namespace to use for the containers in the task. Valid values + // are host or task. PidMode *string `type:"string"` // The placement constraint objects to use for tasks. @@ -18776,7 +19895,7 @@ type AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails struct { // The scope for the Docker volume that determines its lifecycle. Docker volumes // that are scoped to a task are provisioned automatically when the task starts // and destroyed when the task stops. Docker volumes that are shared persist - // after the task stops. + // after the task stops. Valid values are shared or task. Scope *string `type:"string"` } @@ -19401,7 +20520,19 @@ type AwsEksClusterDetails struct { // The certificate authority data for the cluster. CertificateAuthorityData *string `type:"string"` - // The status of the cluster. + // The status of the cluster. Valid values are as follows: + // + // * ACTIVE + // + // * CREATING + // + // * DELETING + // + // * FAILED + // + // * PENDING + // + // * UPDATING ClusterStatus *string `type:"string"` // The endpoint for the Amazon EKS API server. @@ -19503,7 +20634,17 @@ type AwsEksClusterLoggingClusterLoggingDetails struct { // Whether the logging types that are listed in Types are enabled. Enabled *bool `type:"boolean"` - // A list of logging types. + // A list of logging types. Valid values are as follows: + // + // * api + // + // * audit + // + // * authenticator + // + // * controllerManager + // + // * scheduler Types []*string `type:"list"` } @@ -19656,7 +20797,23 @@ type AwsElasticBeanstalkEnvironmentDetails struct { // The name of the solution stack that is deployed with the environment. SolutionStackName *string `type:"string"` - // The current operational status of the environment. + // The current operational status of the environment. Valid values are as follows: + // + // * Aborting + // + // * Launching + // + // * LinkingFrom + // + // * LinkingTo + // + // * Ready + // + // * Terminated + // + // * Terminating + // + // * Updating Status *string `type:"string"` // The tier of the environment. @@ -19885,10 +21042,10 @@ func (s *AwsElasticBeanstalkEnvironmentOptionSetting) SetValue(v string) *AwsEla type AwsElasticBeanstalkEnvironmentTier struct { _ struct{} `type:"structure"` - // The name of the environment tier. + // The name of the environment tier. Valid values are WebServer or Worker. Name *string `type:"string"` - // The type of environment tier. + // The type of environment tier. Valid values are Standard or SQS/HTTP. Type *string `type:"string"` // The version of the environment tier. @@ -20146,14 +21303,22 @@ type AwsElasticsearchDomainElasticsearchClusterConfigDetails struct { DedicatedMasterEnabled *bool `type:"boolean"` // The hardware configuration of the computer that hosts the dedicated master - // node. For example, m3.medium.elasticsearch. If this attribute is specified, + // node. A sample value is m3.medium.elasticsearch. If this attribute is specified, // then DedicatedMasterEnabled must be true. + // + // For a list of valid values, see Supported instance types in Amazon OpenSearch + // Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) + // in the Amazon OpenSearch Service Developer Guide. DedicatedMasterType *string `type:"string"` // The number of data nodes to use in the Elasticsearch domain. InstanceCount *int64 `type:"integer"` // The instance type for your data nodes. For example, m3.medium.elasticsearch. + // + // For a list of valid values, see Supported instance types in Amazon OpenSearch + // Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) + // in the Amazon OpenSearch Service Developer Guide. InstanceType *string `type:"string"` // Configuration options for zone awareness. Provided if ZoneAwarenessEnabled @@ -20448,7 +21613,17 @@ type AwsElasticsearchDomainServiceSoftwareOptions struct { // Whether a service software update is available for the domain. UpdateAvailable *bool `type:"boolean"` - // The status of the service software update. + // The status of the service software update. Valid values are as follows: + // + // * COMPLETED + // + // * ELIGIBLE + // + // * IN_PROGRESS + // + // * NOT_ELIGIBLE + // + // * PENDING_UPDATE UpdateStatus *string `type:"string"` } @@ -22967,7 +24142,17 @@ type AwsKmsKeyDetails struct { // Whether the key has key rotation enabled. KeyRotationStatus *bool `type:"boolean"` - // The state of the KMS key. + // The state of the KMS key. Valid values are as follows: + // + // * Disabled + // + // * Enabled + // + // * PendingDeletion + // + // * PendingImport + // + // * Unavailable KeyState *string `type:"string"` // The source of the KMS key material. @@ -24019,6 +25204,10 @@ type AwsOpenSearchServiceDomainClusterConfigDetails struct { InstanceCount *int64 `type:"integer"` // The instance type for your data nodes. + // + // For a list of valid values, see Supported instance types in Amazon OpenSearch + // Service (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html) + // in the Amazon OpenSearch Service Developer Guide. InstanceType *string `type:"string"` // The number of UltraWarm instances. @@ -24124,7 +25313,7 @@ type AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails struct { _ struct{} `type:"structure"` // The number of Availability Zones that the domain uses. Valid values are 2 - // and 3. The default is 2. + // or 3. The default is 2. AvailabilityZoneCount *int64 `type:"integer"` } @@ -24625,7 +25814,17 @@ type AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails struct { // Whether a service software update is available for the domain. UpdateAvailable *bool `type:"boolean"` - // The status of the service software update. + // The status of the service software update. Valid values are as follows: + // + // * COMPLETED + // + // * ELIGIBLE + // + // * IN_PROGRESS + // + // * NOT_ELIGIBLE + // + // * PENDING_UPDATE UpdateStatus *string `type:"string"` } @@ -24745,7 +25944,14 @@ type AwsRdsDbClusterAssociatedRole struct { // The ARN of the IAM role. RoleArn *string `type:"string"` - // The status of the association between the IAM role and the DB cluster. + // The status of the association between the IAM role and the DB cluster. Valid + // values are as follows: + // + // * ACTIVE + // + // * INVALID + // + // * PENDING Status *string `type:"string"` } @@ -24783,7 +25989,15 @@ func (s *AwsRdsDbClusterAssociatedRole) SetStatus(v string) *AwsRdsDbClusterAsso type AwsRdsDbClusterDetails struct { _ struct{} `type:"structure"` - // The status of the database activity stream. + // The status of the database activity stream. Valid values are as follows: + // + // * started + // + // * starting + // + // * stopped + // + // * stopping ActivityStreamStatus *string `type:"string"` // For all database engines except Aurora, specifies the allocated storage size @@ -24856,10 +26070,27 @@ type AwsRdsDbClusterDetails struct { // The connection endpoint for the primary instance of the DB cluster. Endpoint *string `type:"string"` - // The name of the database engine to use for this DB cluster. + // The name of the database engine to use for this DB cluster. Valid values + // are as follows: + // + // * aurora + // + // * aurora-mysql + // + // * aurora-postgresql Engine *string `type:"string"` - // The database engine mode of the DB cluster. + // The database engine mode of the DB cluster.Valid values are as follows: + // + // * global + // + // * multimaster + // + // * parallelquery + // + // * provisioned + // + // * serverless EngineMode *string `type:"string"` // The version number of the database engine to use. @@ -26514,7 +27745,7 @@ func (s *AwsRdsDbPendingModifiedValues) SetStorageType(v string) *AwsRdsDbPendin type AwsRdsDbProcessorFeature struct { _ struct{} `type:"structure"` - // The name of the processor feature. + // The name of the processor feature. Valid values are coreCount or threadsPerCore. Name *string `type:"string"` // The value of the processor feature. @@ -26762,7 +27993,36 @@ type AwsRdsDbSnapshotDetails struct { // Whether the DB snapshot is encrypted. Encrypted *bool `type:"boolean"` - // The name of the database engine to use for this DB instance. + // The name of the database engine to use for this DB instance. Valid values + // are as follows: + // + // * aurora + // + // * aurora-mysql + // + // * aurora-postgresql + // + // * c + // + // * mariadb + // + // * mysql + // + // * oracle-ee + // + // * oracle-se + // + // * oracle-se1 + // + // * oracle-se2 + // + // * sqlserver-ee + // + // * sqlserver-ex + // + // * sqlserver-se + // + // * sqlserver-web Engine *string `type:"string"` // The version of the database engine. @@ -26817,7 +28077,13 @@ type AwsRdsDbSnapshotDetails struct { // The status of this DB snapshot. Status *string `type:"string"` - // The storage type associated with the DB snapshot. + // The storage type associated with the DB snapshot. Valid values are as follows: + // + // * gp2 + // + // * io1 + // + // * standard StorageType *string `type:"string"` // The ARN from the key store with which to associate the instance for TDE encryption. @@ -29081,7 +30347,8 @@ type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails struct { // A tag filter. Tag *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails `type:"structure"` - // Whether to use AND or OR to join the operands. + // Whether to use AND or OR to join the operands. Valid values are LifecycleAndOperator + // or LifecycleOrOperator. Type *string `type:"string"` } @@ -29137,7 +30404,7 @@ type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails // A tag that is assigned to matching objects. Tag *AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails `type:"structure"` - // The type of filter value. + // The type of filter value. Valid values are LifecyclePrefixPredicate or LifecycleTagPredicate. Type *string `type:"string"` } @@ -29319,7 +30586,17 @@ type AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails struct { // storage class. If you provide Days, you cannot provide Date. Days *int64 `type:"integer"` - // The storage class to transition the object to. + // The storage class to transition the object to. Valid values are as follows: + // + // * DEEP_ARCHIVE + // + // * GLACIER + // + // * INTELLIGENT_TIERING + // + // * ONEZONE_IA + // + // * STANDARD_IA StorageClass *string `type:"string"` } @@ -29368,7 +30645,7 @@ type AwsS3BucketBucketVersioningConfiguration struct { // this attribute is not included. IsMfaDeleteEnabled *bool `type:"boolean"` - // The versioning status of the S3 bucket. + // The versioning status of the S3 bucket. Valid values are Enabled or Suspended. Status *string `type:"string"` } @@ -29627,7 +30904,14 @@ type AwsS3BucketNotificationConfigurationDetail struct { Filter *AwsS3BucketNotificationConfigurationFilter `type:"structure"` // Indicates the type of notification. Notifications can be generated using - // Lambda functions, Amazon SQS queues or Amazon SNS topics. + // Lambda functions, Amazon SQS queues, or Amazon SNS topics, with corresponding + // valid values as follows: + // + // * LambdaConfiguration + // + // * QueueConfiguration + // + // * TopicConfiguration Type *string `type:"string"` } @@ -29788,7 +31072,8 @@ type AwsS3BucketServerSideEncryptionByDefault struct { // KMS key ID to use for the default encryption. KMSMasterKeyID *string `type:"string"` - // Server-side encryption algorithm to use for the default encryption. + // Server-side encryption algorithm to use for the default encryption. Valid + // values are aws: kms or AES256. SSEAlgorithm *string `type:"string"` } @@ -29954,8 +31239,8 @@ type AwsS3BucketWebsiteConfigurationRedirectTo struct { // The name of the host to redirect requests to. Hostname *string `type:"string"` - // The protocol to use when redirecting requests. By default, uses the same - // protocol as the original request. + // The protocol to use when redirecting requests. By default, this field uses + // the same protocol as the original request. Valid values are http or https. Protocol *string `type:"string"` } @@ -30357,10 +31642,9 @@ func (s *AwsSecretsManagerSecretRotationRules) SetAutomaticallyAfterDays(v int64 return s } -// Provides consistent format for the contents of the Security Hub-aggregated -// findings. AwsSecurityFinding format enables you to share findings between -// Amazon Web Services security services and third-party solutions, and security -// standards checks. +// Provides a consistent format for Security Hub findings. AwsSecurityFinding +// format allows you to share findings between Amazon Web Services security +// services and third-party solutions. // // A finding is a potential security issue generated either by Amazon Web Services // services or by the integrated third-party solutions and standards checks. @@ -32258,7 +33542,19 @@ type AwsSsmComplianceSummary struct { // UNSPECIFIED. NonCompliantUnspecifiedCount *int64 `type:"integer"` - // The highest severity for the patches. + // The highest severity for the patches. Valid values are as follows: + // + // * CRITICAL + // + // * HIGH + // + // * MEDIUM + // + // * LOW + // + // * INFORMATIONAL + // + // * UNSPECIFIED OverallSeverity *string `type:"string"` // The identifier of the patch baseline. The patch baseline lists the patches @@ -32270,9 +33566,7 @@ type AwsSsmComplianceSummary struct { // compliance. PatchGroup *string `type:"string"` - // The current patch compliance status. - // - // The possible status values are: + // The current patch compliance status. Valid values are as follows: // // * COMPLIANT // @@ -32572,7 +33866,21 @@ type AwsWafRateBasedRuleMatchPredicate struct { // those that match the predicate settings. Negated *bool `type:"boolean"` - // The type of predicate. + // The type of predicate. Valid values are as follows: + // + // * ByteMatch + // + // * GeoMatch + // + // * IPMatch + // + // * RegexMatch + // + // * SizeConstraint + // + // * SqlInjectionMatch + // + // * XssMatch Type *string `type:"string"` } @@ -32711,7 +34019,21 @@ type AwsWafRegionalRateBasedRuleMatchPredicate struct { // those that match the predicate settings. Negated *bool `type:"boolean"` - // The type of predicate. + // The type of predicate. Valid values are as follows: + // + // * ByteMatch + // + // * GeoMatch + // + // * IPMatch + // + // * RegexMatch + // + // * SizeConstraint + // + // * SqlInjectionMatch + // + // * XssMatch Type *string `type:"string"` } @@ -33677,12 +34999,14 @@ type AwsXrayEncryptionConfigDetails struct { // is KMS. KeyId *string `type:"string"` - // The current status of the encryption configuration. When Status is UPDATING, - // X-Ray might use both the old and new encryption. + // The current status of the encryption configuration. Valid values are ACTIVE + // or UPDATING. + // + // When Status is equal to UPDATING, X-Ray might use both the old and new encryption. Status *string `type:"string"` // The type of encryption. KMS indicates that the encryption uses KMS keys. - // NONE indicates to use the default encryption. + // NONE indicates the default encryption. Type *string `type:"string"` } @@ -34251,24 +35575,27 @@ type BatchUpdateFindingsUnprocessedFinding struct { // The code associated with the error. Possible values are: // - // * ConcurrentUpdateError - Another process or request attempted to update - // the finding while this request was being processed + // * ConcurrentUpdateError - Another request attempted to update the finding + // while this request was being processed. This error may also occur if you + // call BatchUpdateFindings (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html) + // and BatchImportFindings (https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html) + // at the same time. // // * DuplicatedFindingIdentifier - The request included two or more findings - // with the same FindingIdentifier + // with the same FindingIdentifier. // // * FindingNotFound - The FindingIdentifier included in the request did - // not match an existing finding + // not match an existing finding. // // * FindingSizeExceeded - The finding size was greater than the permissible - // value of 240 KB + // value of 240 KB. // // * InternalFailure - An internal service failure occurred when updating - // the finding + // the finding. // // * InvalidInput - The finding update contained an invalid value that did // not satisfy the Amazon Web Services Security Finding Format (https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) - // syntax + // syntax. // // ErrorCode is a required field ErrorCode *string `type:"string" required:"true"` @@ -39251,7 +40578,19 @@ type Ipv6CidrBlockAssociation struct { // The association ID for the IPv6 CIDR block. AssociationId *string `type:"string"` - // Information about the state of the CIDR block. + // Information about the state of the CIDR block. Valid values are as follows: + // + // * associating + // + // * associated + // + // * disassociating + // + // * disassociated + // + // * failed + // + // * failing CidrBlockState *string `type:"string"` // The IPv6 CIDR block. @@ -41966,6 +43305,15 @@ type ResourceDetails struct { // Provides details about a launch configuration. AwsAutoScalingLaunchConfiguration *AwsAutoScalingLaunchConfigurationDetails `type:"structure"` + // Provides details about an Backup backup plan. + AwsBackupBackupPlan *AwsBackupBackupPlanDetails `type:"structure"` + + // Provides details about an Backup backup vault. + AwsBackupBackupVault *AwsBackupBackupVaultDetails `type:"structure"` + + // Provides details about an Backup backup, or recovery point. + AwsBackupRecoveryPoint *AwsBackupRecoveryPointDetails `type:"structure"` + // Provides details about an Certificate Manager certificate. AwsCertificateManagerCertificate *AwsCertificateManagerCertificateDetails `type:"structure"` @@ -42266,6 +43614,24 @@ func (s *ResourceDetails) SetAwsAutoScalingLaunchConfiguration(v *AwsAutoScaling return s } +// SetAwsBackupBackupPlan sets the AwsBackupBackupPlan field's value. +func (s *ResourceDetails) SetAwsBackupBackupPlan(v *AwsBackupBackupPlanDetails) *ResourceDetails { + s.AwsBackupBackupPlan = v + return s +} + +// SetAwsBackupBackupVault sets the AwsBackupBackupVault field's value. +func (s *ResourceDetails) SetAwsBackupBackupVault(v *AwsBackupBackupVaultDetails) *ResourceDetails { + s.AwsBackupBackupVault = v + return s +} + +// SetAwsBackupRecoveryPoint sets the AwsBackupRecoveryPoint field's value. +func (s *ResourceDetails) SetAwsBackupRecoveryPoint(v *AwsBackupRecoveryPointDetails) *ResourceDetails { + s.AwsBackupRecoveryPoint = v + return s +} + // SetAwsCertificateManagerCertificate sets the AwsCertificateManagerCertificate field's value. func (s *ResourceDetails) SetAwsCertificateManagerCertificate(v *AwsCertificateManagerCertificateDetails) *ResourceDetails { s.AwsCertificateManagerCertificate = v @@ -43971,6 +45337,9 @@ type SoftwarePackage struct { // The file system path to the package manager inventory file. FilePath *string `type:"string"` + // The version of the software package in which the vulnerability has been resolved. + FixedInVersion *string `type:"string"` + // The name of the software package. Name *string `type:"string"` @@ -43980,6 +45349,10 @@ type SoftwarePackage struct { // The release of the software package. Release *string `type:"string"` + // Describes the actions a customer can take to resolve the vulnerability in + // the software package. + Remediation *string `type:"string"` + // The version of the software package. Version *string `type:"string"` } @@ -44020,6 +45393,12 @@ func (s *SoftwarePackage) SetFilePath(v string) *SoftwarePackage { return s } +// SetFixedInVersion sets the FixedInVersion field's value. +func (s *SoftwarePackage) SetFixedInVersion(v string) *SoftwarePackage { + s.FixedInVersion = &v + return s +} + // SetName sets the Name field's value. func (s *SoftwarePackage) SetName(v string) *SoftwarePackage { s.Name = &v @@ -44038,6 +45417,12 @@ func (s *SoftwarePackage) SetRelease(v string) *SoftwarePackage { return s } +// SetRemediation sets the Remediation field's value. +func (s *SoftwarePackage) SetRemediation(v string) *SoftwarePackage { + s.Remediation = &v + return s +} + // SetVersion sets the Version field's value. func (s *SoftwarePackage) SetVersion(v string) *SoftwarePackage { s.Version = &v @@ -45856,6 +47241,19 @@ type Vulnerability struct { // CVSS scores from the advisory related to the vulnerability. Cvss []*Cvss `type:"list"` + // Specifies if all vulnerable packages in a finding have a value for FixedInVersion + // and Remediation. This field is evaluated for each vulnerability Id based + // on the number of vulnerable packages that have a value for both FixedInVersion + // and Remediation. Valid values are as follows: + // + // * YES if all vulnerable packages have a value for both FixedInVersion + // and Remediation + // + // * NO if no vulnerable packages have a value for FixedInVersion and Remediation + // + // * PARTIAL otherwise + FixAvailable *string `type:"string" enum:"VulnerabilityFixAvailable"` + // The identifier of the vulnerability. // // Id is a required field @@ -45916,6 +47314,12 @@ func (s *Vulnerability) SetCvss(v []*Cvss) *Vulnerability { return s } +// SetFixAvailable sets the FixAvailable field's value. +func (s *Vulnerability) SetFixAvailable(v string) *Vulnerability { + s.FixAvailable = &v + return s +} + // SetId sets the Id field's value. func (s *Vulnerability) SetId(v string) *Vulnerability { s.Id = &v @@ -46788,6 +48192,26 @@ func VerificationState_Values() []string { } } +const ( + // VulnerabilityFixAvailableYes is a VulnerabilityFixAvailable enum value + VulnerabilityFixAvailableYes = "YES" + + // VulnerabilityFixAvailableNo is a VulnerabilityFixAvailable enum value + VulnerabilityFixAvailableNo = "NO" + + // VulnerabilityFixAvailablePartial is a VulnerabilityFixAvailable enum value + VulnerabilityFixAvailablePartial = "PARTIAL" +) + +// VulnerabilityFixAvailable_Values returns all elements of the VulnerabilityFixAvailable enum +func VulnerabilityFixAvailable_Values() []string { + return []string{ + VulnerabilityFixAvailableYes, + VulnerabilityFixAvailableNo, + VulnerabilityFixAvailablePartial, + } +} + const ( // WorkflowStateNew is a WorkflowState enum value WorkflowStateNew = "NEW" diff --git a/service/supportapp/api.go b/service/supportapp/api.go new file mode 100644 index 0000000000..56472b13c5 --- /dev/null +++ b/service/supportapp/api.go @@ -0,0 +1,2482 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package supportapp + +import ( + "fmt" + + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/awsutil" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +const opCreateSlackChannelConfiguration = "CreateSlackChannelConfiguration" + +// CreateSlackChannelConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the CreateSlackChannelConfiguration 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 CreateSlackChannelConfiguration for more information on using the CreateSlackChannelConfiguration +// 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 CreateSlackChannelConfigurationRequest method. +// req, resp := client.CreateSlackChannelConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/CreateSlackChannelConfiguration +func (c *SupportApp) CreateSlackChannelConfigurationRequest(input *CreateSlackChannelConfigurationInput) (req *request.Request, output *CreateSlackChannelConfigurationOutput) { + op := &request.Operation{ + Name: opCreateSlackChannelConfiguration, + HTTPMethod: "POST", + HTTPPath: "/control/create-slack-channel-configuration", + } + + if input == nil { + input = &CreateSlackChannelConfigurationInput{} + } + + output = &CreateSlackChannelConfigurationOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// CreateSlackChannelConfiguration API operation for AWS Support App. +// +// Creates a Slack channel configuration for your Amazon Web Services account. +// +// - You can add up to 5 Slack workspaces for your account. +// +// - You can add up to 20 Slack channels for your account. +// +// A Slack channel can have up to 100 Amazon Web Services accounts. This means +// that only 100 accounts can add the same Slack channel to the Amazon Web Services +// Support App. We recommend that you only add the accounts that you need to +// manage support cases for your organization. This can reduce the notifications +// about case updates that you receive in the Slack channel. +// +// We recommend that you choose a private Slack channel so that only members +// in that channel have read and write access to your support cases. Anyone +// in your Slack channel can create, update, or resolve support cases for your +// account. Users require an invitation to join private channels. +// +// 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 Support App's +// API operation CreateSlackChannelConfiguration for usage and error information. +// +// Returned Error Types: +// +// - ServiceQuotaExceededException +// Your Service Quotas request exceeds the quota for the service. For example, +// your Service Quotas request to Amazon Web Services Support App might exceed +// the maximum number of workspaces or channels per account, or the maximum +// number of accounts per Slack channel. +// +// - ConflictException +// Your request has a conflict. For example, you might receive this error if +// you try the following: +// +// - Add, update, or delete a Slack channel configuration before you add +// a Slack workspace to your Amazon Web Services account. +// +// - Add a Slack channel configuration that already exists in your Amazon +// Web Services account. +// +// - Delete a Slack channel configuration for a live chat channel. +// +// - Delete a Slack workspace from your Amazon Web Services account that +// has an active live chat channel. +// +// - AccessDeniedException +// You don't have sufficient permission to perform this action. +// +// - InternalServerException +// We can’t process your request right now because of a server issue. Try +// again later. +// +// - ValidationException +// Your request input doesn't meet the constraints that the Amazon Web Services +// Support App specifies. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/CreateSlackChannelConfiguration +func (c *SupportApp) CreateSlackChannelConfiguration(input *CreateSlackChannelConfigurationInput) (*CreateSlackChannelConfigurationOutput, error) { + req, out := c.CreateSlackChannelConfigurationRequest(input) + return out, req.Send() +} + +// CreateSlackChannelConfigurationWithContext is the same as CreateSlackChannelConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See CreateSlackChannelConfiguration 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 *SupportApp) CreateSlackChannelConfigurationWithContext(ctx aws.Context, input *CreateSlackChannelConfigurationInput, opts ...request.Option) (*CreateSlackChannelConfigurationOutput, error) { + req, out := c.CreateSlackChannelConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteAccountAlias = "DeleteAccountAlias" + +// DeleteAccountAliasRequest generates a "aws/request.Request" representing the +// client's request for the DeleteAccountAlias 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 DeleteAccountAlias for more information on using the DeleteAccountAlias +// 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 DeleteAccountAliasRequest method. +// req, resp := client.DeleteAccountAliasRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/DeleteAccountAlias +func (c *SupportApp) DeleteAccountAliasRequest(input *DeleteAccountAliasInput) (req *request.Request, output *DeleteAccountAliasOutput) { + op := &request.Operation{ + Name: opDeleteAccountAlias, + HTTPMethod: "POST", + HTTPPath: "/control/delete-account-alias", + } + + if input == nil { + input = &DeleteAccountAliasInput{} + } + + output = &DeleteAccountAliasOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteAccountAlias API operation for AWS Support App. +// +// Deletes an alias for an Amazon Web Services account ID. The alias appears +// in the Amazon Web Services Support App page of the Amazon Web Services Support +// Center. The alias also appears in Slack messages from the Amazon Web Services +// Support App. +// +// 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 Support App's +// API operation DeleteAccountAlias for usage and error information. +// +// Returned Error Types: +// +// - ResourceNotFoundException +// The specified resource is missing or doesn't exist, such as an account alias +// or Slack channel configuration. +// +// - AccessDeniedException +// You don't have sufficient permission to perform this action. +// +// - InternalServerException +// We can’t process your request right now because of a server issue. Try +// again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/DeleteAccountAlias +func (c *SupportApp) DeleteAccountAlias(input *DeleteAccountAliasInput) (*DeleteAccountAliasOutput, error) { + req, out := c.DeleteAccountAliasRequest(input) + return out, req.Send() +} + +// DeleteAccountAliasWithContext is the same as DeleteAccountAlias with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteAccountAlias 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 *SupportApp) DeleteAccountAliasWithContext(ctx aws.Context, input *DeleteAccountAliasInput, opts ...request.Option) (*DeleteAccountAliasOutput, error) { + req, out := c.DeleteAccountAliasRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteSlackChannelConfiguration = "DeleteSlackChannelConfiguration" + +// DeleteSlackChannelConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the DeleteSlackChannelConfiguration 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 DeleteSlackChannelConfiguration for more information on using the DeleteSlackChannelConfiguration +// 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 DeleteSlackChannelConfigurationRequest method. +// req, resp := client.DeleteSlackChannelConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/DeleteSlackChannelConfiguration +func (c *SupportApp) DeleteSlackChannelConfigurationRequest(input *DeleteSlackChannelConfigurationInput) (req *request.Request, output *DeleteSlackChannelConfigurationOutput) { + op := &request.Operation{ + Name: opDeleteSlackChannelConfiguration, + HTTPMethod: "POST", + HTTPPath: "/control/delete-slack-channel-configuration", + } + + if input == nil { + input = &DeleteSlackChannelConfigurationInput{} + } + + output = &DeleteSlackChannelConfigurationOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteSlackChannelConfiguration API operation for AWS Support App. +// +// Deletes a Slack channel configuration from your Amazon Web Services account. +// This operation doesn't delete your Slack channel. +// +// 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 Support App's +// API operation DeleteSlackChannelConfiguration for usage and error information. +// +// Returned Error Types: +// +// - ConflictException +// Your request has a conflict. For example, you might receive this error if +// you try the following: +// +// - Add, update, or delete a Slack channel configuration before you add +// a Slack workspace to your Amazon Web Services account. +// +// - Add a Slack channel configuration that already exists in your Amazon +// Web Services account. +// +// - Delete a Slack channel configuration for a live chat channel. +// +// - Delete a Slack workspace from your Amazon Web Services account that +// has an active live chat channel. +// +// - ResourceNotFoundException +// The specified resource is missing or doesn't exist, such as an account alias +// or Slack channel configuration. +// +// - AccessDeniedException +// You don't have sufficient permission to perform this action. +// +// - InternalServerException +// We can’t process your request right now because of a server issue. Try +// again later. +// +// - ValidationException +// Your request input doesn't meet the constraints that the Amazon Web Services +// Support App specifies. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/DeleteSlackChannelConfiguration +func (c *SupportApp) DeleteSlackChannelConfiguration(input *DeleteSlackChannelConfigurationInput) (*DeleteSlackChannelConfigurationOutput, error) { + req, out := c.DeleteSlackChannelConfigurationRequest(input) + return out, req.Send() +} + +// DeleteSlackChannelConfigurationWithContext is the same as DeleteSlackChannelConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteSlackChannelConfiguration 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 *SupportApp) DeleteSlackChannelConfigurationWithContext(ctx aws.Context, input *DeleteSlackChannelConfigurationInput, opts ...request.Option) (*DeleteSlackChannelConfigurationOutput, error) { + req, out := c.DeleteSlackChannelConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteSlackWorkspaceConfiguration = "DeleteSlackWorkspaceConfiguration" + +// DeleteSlackWorkspaceConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the DeleteSlackWorkspaceConfiguration 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 DeleteSlackWorkspaceConfiguration for more information on using the DeleteSlackWorkspaceConfiguration +// 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 DeleteSlackWorkspaceConfigurationRequest method. +// req, resp := client.DeleteSlackWorkspaceConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/DeleteSlackWorkspaceConfiguration +func (c *SupportApp) DeleteSlackWorkspaceConfigurationRequest(input *DeleteSlackWorkspaceConfigurationInput) (req *request.Request, output *DeleteSlackWorkspaceConfigurationOutput) { + op := &request.Operation{ + Name: opDeleteSlackWorkspaceConfiguration, + HTTPMethod: "POST", + HTTPPath: "/control/delete-slack-workspace-configuration", + } + + if input == nil { + input = &DeleteSlackWorkspaceConfigurationInput{} + } + + output = &DeleteSlackWorkspaceConfigurationOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteSlackWorkspaceConfiguration API operation for AWS Support App. +// +// Deletes a Slack workspace configuration from your Amazon Web Services account. +// This operation doesn't delete your Slack workspace. +// +// 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 Support App's +// API operation DeleteSlackWorkspaceConfiguration for usage and error information. +// +// Returned Error Types: +// +// - ConflictException +// Your request has a conflict. For example, you might receive this error if +// you try the following: +// +// - Add, update, or delete a Slack channel configuration before you add +// a Slack workspace to your Amazon Web Services account. +// +// - Add a Slack channel configuration that already exists in your Amazon +// Web Services account. +// +// - Delete a Slack channel configuration for a live chat channel. +// +// - Delete a Slack workspace from your Amazon Web Services account that +// has an active live chat channel. +// +// - ResourceNotFoundException +// The specified resource is missing or doesn't exist, such as an account alias +// or Slack channel configuration. +// +// - AccessDeniedException +// You don't have sufficient permission to perform this action. +// +// - InternalServerException +// We can’t process your request right now because of a server issue. Try +// again later. +// +// - ValidationException +// Your request input doesn't meet the constraints that the Amazon Web Services +// Support App specifies. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/DeleteSlackWorkspaceConfiguration +func (c *SupportApp) DeleteSlackWorkspaceConfiguration(input *DeleteSlackWorkspaceConfigurationInput) (*DeleteSlackWorkspaceConfigurationOutput, error) { + req, out := c.DeleteSlackWorkspaceConfigurationRequest(input) + return out, req.Send() +} + +// DeleteSlackWorkspaceConfigurationWithContext is the same as DeleteSlackWorkspaceConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteSlackWorkspaceConfiguration 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 *SupportApp) DeleteSlackWorkspaceConfigurationWithContext(ctx aws.Context, input *DeleteSlackWorkspaceConfigurationInput, opts ...request.Option) (*DeleteSlackWorkspaceConfigurationOutput, error) { + req, out := c.DeleteSlackWorkspaceConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetAccountAlias = "GetAccountAlias" + +// GetAccountAliasRequest generates a "aws/request.Request" representing the +// client's request for the GetAccountAlias 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 GetAccountAlias for more information on using the GetAccountAlias +// 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 GetAccountAliasRequest method. +// req, resp := client.GetAccountAliasRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/GetAccountAlias +func (c *SupportApp) GetAccountAliasRequest(input *GetAccountAliasInput) (req *request.Request, output *GetAccountAliasOutput) { + op := &request.Operation{ + Name: opGetAccountAlias, + HTTPMethod: "POST", + HTTPPath: "/control/get-account-alias", + } + + if input == nil { + input = &GetAccountAliasInput{} + } + + output = &GetAccountAliasOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetAccountAlias API operation for AWS Support App. +// +// Retrieves the alias from an Amazon Web Services account ID. The alias appears +// in the Amazon Web Services Support App page of the Amazon Web Services Support +// Center. The alias also appears in Slack messages from the Amazon Web Services +// Support App. +// +// 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 Support App's +// API operation GetAccountAlias for usage and error information. +// +// Returned Error Types: +// - InternalServerException +// We can’t process your request right now because of a server issue. Try +// again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/GetAccountAlias +func (c *SupportApp) GetAccountAlias(input *GetAccountAliasInput) (*GetAccountAliasOutput, error) { + req, out := c.GetAccountAliasRequest(input) + return out, req.Send() +} + +// GetAccountAliasWithContext is the same as GetAccountAlias with the addition of +// the ability to pass a context and additional request options. +// +// See GetAccountAlias 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 *SupportApp) GetAccountAliasWithContext(ctx aws.Context, input *GetAccountAliasInput, opts ...request.Option) (*GetAccountAliasOutput, error) { + req, out := c.GetAccountAliasRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListSlackChannelConfigurations = "ListSlackChannelConfigurations" + +// ListSlackChannelConfigurationsRequest generates a "aws/request.Request" representing the +// client's request for the ListSlackChannelConfigurations 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 ListSlackChannelConfigurations for more information on using the ListSlackChannelConfigurations +// 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 ListSlackChannelConfigurationsRequest method. +// req, resp := client.ListSlackChannelConfigurationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/ListSlackChannelConfigurations +func (c *SupportApp) ListSlackChannelConfigurationsRequest(input *ListSlackChannelConfigurationsInput) (req *request.Request, output *ListSlackChannelConfigurationsOutput) { + op := &request.Operation{ + Name: opListSlackChannelConfigurations, + HTTPMethod: "POST", + HTTPPath: "/control/list-slack-channel-configurations", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListSlackChannelConfigurationsInput{} + } + + output = &ListSlackChannelConfigurationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListSlackChannelConfigurations API operation for AWS Support App. +// +// Lists the Slack channel configurations for an 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 Support App's +// API operation ListSlackChannelConfigurations for usage and error information. +// +// Returned Error Types: +// +// - AccessDeniedException +// You don't have sufficient permission to perform this action. +// +// - InternalServerException +// We can’t process your request right now because of a server issue. Try +// again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/ListSlackChannelConfigurations +func (c *SupportApp) ListSlackChannelConfigurations(input *ListSlackChannelConfigurationsInput) (*ListSlackChannelConfigurationsOutput, error) { + req, out := c.ListSlackChannelConfigurationsRequest(input) + return out, req.Send() +} + +// ListSlackChannelConfigurationsWithContext is the same as ListSlackChannelConfigurations with the addition of +// the ability to pass a context and additional request options. +// +// See ListSlackChannelConfigurations 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 *SupportApp) ListSlackChannelConfigurationsWithContext(ctx aws.Context, input *ListSlackChannelConfigurationsInput, opts ...request.Option) (*ListSlackChannelConfigurationsOutput, error) { + req, out := c.ListSlackChannelConfigurationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListSlackChannelConfigurationsPages iterates over the pages of a ListSlackChannelConfigurations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListSlackChannelConfigurations 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 ListSlackChannelConfigurations operation. +// pageNum := 0 +// err := client.ListSlackChannelConfigurationsPages(params, +// func(page *supportapp.ListSlackChannelConfigurationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *SupportApp) ListSlackChannelConfigurationsPages(input *ListSlackChannelConfigurationsInput, fn func(*ListSlackChannelConfigurationsOutput, bool) bool) error { + return c.ListSlackChannelConfigurationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListSlackChannelConfigurationsPagesWithContext same as ListSlackChannelConfigurationsPages 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 *SupportApp) ListSlackChannelConfigurationsPagesWithContext(ctx aws.Context, input *ListSlackChannelConfigurationsInput, fn func(*ListSlackChannelConfigurationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListSlackChannelConfigurationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListSlackChannelConfigurationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListSlackChannelConfigurationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListSlackWorkspaceConfigurations = "ListSlackWorkspaceConfigurations" + +// ListSlackWorkspaceConfigurationsRequest generates a "aws/request.Request" representing the +// client's request for the ListSlackWorkspaceConfigurations 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 ListSlackWorkspaceConfigurations for more information on using the ListSlackWorkspaceConfigurations +// 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 ListSlackWorkspaceConfigurationsRequest method. +// req, resp := client.ListSlackWorkspaceConfigurationsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/ListSlackWorkspaceConfigurations +func (c *SupportApp) ListSlackWorkspaceConfigurationsRequest(input *ListSlackWorkspaceConfigurationsInput) (req *request.Request, output *ListSlackWorkspaceConfigurationsOutput) { + op := &request.Operation{ + Name: opListSlackWorkspaceConfigurations, + HTTPMethod: "POST", + HTTPPath: "/control/list-slack-workspace-configurations", + Paginator: &request.Paginator{ + InputTokens: []string{"nextToken"}, + OutputTokens: []string{"nextToken"}, + LimitToken: "", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListSlackWorkspaceConfigurationsInput{} + } + + output = &ListSlackWorkspaceConfigurationsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListSlackWorkspaceConfigurations API operation for AWS Support App. +// +// Lists the Slack workspace configurations for an 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 Support App's +// API operation ListSlackWorkspaceConfigurations for usage and error information. +// +// Returned Error Types: +// +// - AccessDeniedException +// You don't have sufficient permission to perform this action. +// +// - InternalServerException +// We can’t process your request right now because of a server issue. Try +// again later. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/ListSlackWorkspaceConfigurations +func (c *SupportApp) ListSlackWorkspaceConfigurations(input *ListSlackWorkspaceConfigurationsInput) (*ListSlackWorkspaceConfigurationsOutput, error) { + req, out := c.ListSlackWorkspaceConfigurationsRequest(input) + return out, req.Send() +} + +// ListSlackWorkspaceConfigurationsWithContext is the same as ListSlackWorkspaceConfigurations with the addition of +// the ability to pass a context and additional request options. +// +// See ListSlackWorkspaceConfigurations 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 *SupportApp) ListSlackWorkspaceConfigurationsWithContext(ctx aws.Context, input *ListSlackWorkspaceConfigurationsInput, opts ...request.Option) (*ListSlackWorkspaceConfigurationsOutput, error) { + req, out := c.ListSlackWorkspaceConfigurationsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListSlackWorkspaceConfigurationsPages iterates over the pages of a ListSlackWorkspaceConfigurations operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListSlackWorkspaceConfigurations 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 ListSlackWorkspaceConfigurations operation. +// pageNum := 0 +// err := client.ListSlackWorkspaceConfigurationsPages(params, +// func(page *supportapp.ListSlackWorkspaceConfigurationsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +func (c *SupportApp) ListSlackWorkspaceConfigurationsPages(input *ListSlackWorkspaceConfigurationsInput, fn func(*ListSlackWorkspaceConfigurationsOutput, bool) bool) error { + return c.ListSlackWorkspaceConfigurationsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListSlackWorkspaceConfigurationsPagesWithContext same as ListSlackWorkspaceConfigurationsPages 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 *SupportApp) ListSlackWorkspaceConfigurationsPagesWithContext(ctx aws.Context, input *ListSlackWorkspaceConfigurationsInput, fn func(*ListSlackWorkspaceConfigurationsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListSlackWorkspaceConfigurationsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListSlackWorkspaceConfigurationsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListSlackWorkspaceConfigurationsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opPutAccountAlias = "PutAccountAlias" + +// PutAccountAliasRequest generates a "aws/request.Request" representing the +// client's request for the PutAccountAlias 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 PutAccountAlias for more information on using the PutAccountAlias +// 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 PutAccountAliasRequest method. +// req, resp := client.PutAccountAliasRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/PutAccountAlias +func (c *SupportApp) PutAccountAliasRequest(input *PutAccountAliasInput) (req *request.Request, output *PutAccountAliasOutput) { + op := &request.Operation{ + Name: opPutAccountAlias, + HTTPMethod: "POST", + HTTPPath: "/control/put-account-alias", + } + + if input == nil { + input = &PutAccountAliasInput{} + } + + output = &PutAccountAliasOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(restjson.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// PutAccountAlias API operation for AWS Support App. +// +// Creates or updates an individual alias for each Amazon Web Services account +// ID. The alias appears in the Amazon Web Services Support App page of the +// Amazon Web Services Support Center. The alias also appears in Slack messages +// from the Amazon Web Services Support App. +// +// 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 Support App's +// API operation PutAccountAlias for usage and error information. +// +// Returned Error Types: +// +// - AccessDeniedException +// You don't have sufficient permission to perform this action. +// +// - InternalServerException +// We can’t process your request right now because of a server issue. Try +// again later. +// +// - ValidationException +// Your request input doesn't meet the constraints that the Amazon Web Services +// Support App specifies. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/PutAccountAlias +func (c *SupportApp) PutAccountAlias(input *PutAccountAliasInput) (*PutAccountAliasOutput, error) { + req, out := c.PutAccountAliasRequest(input) + return out, req.Send() +} + +// PutAccountAliasWithContext is the same as PutAccountAlias with the addition of +// the ability to pass a context and additional request options. +// +// See PutAccountAlias 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 *SupportApp) PutAccountAliasWithContext(ctx aws.Context, input *PutAccountAliasInput, opts ...request.Option) (*PutAccountAliasOutput, error) { + req, out := c.PutAccountAliasRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateSlackChannelConfiguration = "UpdateSlackChannelConfiguration" + +// UpdateSlackChannelConfigurationRequest generates a "aws/request.Request" representing the +// client's request for the UpdateSlackChannelConfiguration 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 UpdateSlackChannelConfiguration for more information on using the UpdateSlackChannelConfiguration +// 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 UpdateSlackChannelConfigurationRequest method. +// req, resp := client.UpdateSlackChannelConfigurationRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/UpdateSlackChannelConfiguration +func (c *SupportApp) UpdateSlackChannelConfigurationRequest(input *UpdateSlackChannelConfigurationInput) (req *request.Request, output *UpdateSlackChannelConfigurationOutput) { + op := &request.Operation{ + Name: opUpdateSlackChannelConfiguration, + HTTPMethod: "POST", + HTTPPath: "/control/update-slack-channel-configuration", + } + + if input == nil { + input = &UpdateSlackChannelConfigurationInput{} + } + + output = &UpdateSlackChannelConfigurationOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateSlackChannelConfiguration API operation for AWS Support App. +// +// Updates the configuration for a Slack channel, such as case update 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 Support App's +// API operation UpdateSlackChannelConfiguration for usage and error information. +// +// Returned Error Types: +// +// - ConflictException +// Your request has a conflict. For example, you might receive this error if +// you try the following: +// +// - Add, update, or delete a Slack channel configuration before you add +// a Slack workspace to your Amazon Web Services account. +// +// - Add a Slack channel configuration that already exists in your Amazon +// Web Services account. +// +// - Delete a Slack channel configuration for a live chat channel. +// +// - Delete a Slack workspace from your Amazon Web Services account that +// has an active live chat channel. +// +// - ResourceNotFoundException +// The specified resource is missing or doesn't exist, such as an account alias +// or Slack channel configuration. +// +// - AccessDeniedException +// You don't have sufficient permission to perform this action. +// +// - InternalServerException +// We can’t process your request right now because of a server issue. Try +// again later. +// +// - ValidationException +// Your request input doesn't meet the constraints that the Amazon Web Services +// Support App specifies. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20/UpdateSlackChannelConfiguration +func (c *SupportApp) UpdateSlackChannelConfiguration(input *UpdateSlackChannelConfigurationInput) (*UpdateSlackChannelConfigurationOutput, error) { + req, out := c.UpdateSlackChannelConfigurationRequest(input) + return out, req.Send() +} + +// UpdateSlackChannelConfigurationWithContext is the same as UpdateSlackChannelConfiguration with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateSlackChannelConfiguration 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 *SupportApp) UpdateSlackChannelConfigurationWithContext(ctx aws.Context, input *UpdateSlackChannelConfigurationInput, opts ...request.Option) (*UpdateSlackChannelConfigurationOutput, error) { + req, out := c.UpdateSlackChannelConfigurationRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// You don't have sufficient permission to perform this action. +type AccessDeniedException 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 AccessDeniedException) 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 AccessDeniedException) GoString() string { + return s.String() +} + +func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { + return &AccessDeniedException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *AccessDeniedException) Code() string { + return "AccessDeniedException" +} + +// Message returns the exception's message. +func (s *AccessDeniedException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *AccessDeniedException) OrigErr() error { + return nil +} + +func (s *AccessDeniedException) 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 *AccessDeniedException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *AccessDeniedException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Your request has a conflict. For example, you might receive this error if +// you try the following: +// +// - Add, update, or delete a Slack channel configuration before you add +// a Slack workspace to your Amazon Web Services account. +// +// - Add a Slack channel configuration that already exists in your Amazon +// Web Services account. +// +// - Delete a Slack channel configuration for a live chat channel. +// +// - Delete a Slack workspace from your Amazon Web Services account that +// has an active live chat channel. +type ConflictException 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 ConflictException) 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 ConflictException) GoString() string { + return s.String() +} + +func newErrorConflictException(v protocol.ResponseMetadata) error { + return &ConflictException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ConflictException) Code() string { + return "ConflictException" +} + +// Message returns the exception's message. +func (s *ConflictException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ConflictException) OrigErr() error { + return nil +} + +func (s *ConflictException) 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 *ConflictException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ConflictException) RequestID() string { + return s.RespMetadata.RequestID +} + +type CreateSlackChannelConfigurationInput struct { + _ struct{} `type:"structure"` + + // The channel ID in Slack. This ID identifies a channel within a Slack workspace. + // + // ChannelId is a required field + ChannelId *string `locationName:"channelId" min:"1" type:"string" required:"true"` + + // The name of the Slack channel that you configure for the Amazon Web Services + // Support App. + ChannelName *string `locationName:"channelName" min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of an IAM role that you want to use to perform + // operations on Amazon Web Services. For more information, see Managing access + // to the Amazon Web Services Support App (https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html) + // in the Amazon Web Services Support User Guide. + // + // ChannelRoleArn is a required field + ChannelRoleArn *string `locationName:"channelRoleArn" min:"31" type:"string" required:"true"` + + // Whether you want to get notified when a support case has a new correspondence. + NotifyOnAddCorrespondenceToCase *bool `locationName:"notifyOnAddCorrespondenceToCase" type:"boolean"` + + // The case severity for a support case that you want to receive notifications. + // + //

If you specify high or all, you must specify + // true for at least one of the following parameters:

    + //

  • notifyOnAddCorrespondenceToCase

  • + //

    notifyOnCreateOrReopenCase

  • notifyOnResolveCase + //

If you specify none, the following parameters + // must be null or false:

  • notifyOnAddCorrespondenceToCase + //

  • notifyOnCreateOrReopenCase

    • + //

  • notifyOnResolveCase

If + // you don't specify these parameters in your request, they default to false.

+ // + // + // NotifyOnCaseSeverity is a required field + NotifyOnCaseSeverity *string `locationName:"notifyOnCaseSeverity" type:"string" required:"true" enum:"NotificationSeverityLevel"` + + // Whether you want to get notified when a support case is created or reopened. + NotifyOnCreateOrReopenCase *bool `locationName:"notifyOnCreateOrReopenCase" type:"boolean"` + + // Whether you want to get notified when a support case is resolved. + NotifyOnResolveCase *bool `locationName:"notifyOnResolveCase" type:"boolean"` + + // The team ID in Slack. This ID uniquely identifies a Slack workspace. + // + // TeamId is a required field + TeamId *string `locationName:"teamId" 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 CreateSlackChannelConfigurationInput) 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 CreateSlackChannelConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateSlackChannelConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateSlackChannelConfigurationInput"} + if s.ChannelId == nil { + invalidParams.Add(request.NewErrParamRequired("ChannelId")) + } + if s.ChannelId != nil && len(*s.ChannelId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ChannelId", 1)) + } + if s.ChannelName != nil && len(*s.ChannelName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ChannelName", 1)) + } + if s.ChannelRoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("ChannelRoleArn")) + } + if s.ChannelRoleArn != nil && len(*s.ChannelRoleArn) < 31 { + invalidParams.Add(request.NewErrParamMinLen("ChannelRoleArn", 31)) + } + if s.NotifyOnCaseSeverity == nil { + invalidParams.Add(request.NewErrParamRequired("NotifyOnCaseSeverity")) + } + if s.TeamId == nil { + invalidParams.Add(request.NewErrParamRequired("TeamId")) + } + if s.TeamId != nil && len(*s.TeamId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TeamId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetChannelId sets the ChannelId field's value. +func (s *CreateSlackChannelConfigurationInput) SetChannelId(v string) *CreateSlackChannelConfigurationInput { + s.ChannelId = &v + return s +} + +// SetChannelName sets the ChannelName field's value. +func (s *CreateSlackChannelConfigurationInput) SetChannelName(v string) *CreateSlackChannelConfigurationInput { + s.ChannelName = &v + return s +} + +// SetChannelRoleArn sets the ChannelRoleArn field's value. +func (s *CreateSlackChannelConfigurationInput) SetChannelRoleArn(v string) *CreateSlackChannelConfigurationInput { + s.ChannelRoleArn = &v + return s +} + +// SetNotifyOnAddCorrespondenceToCase sets the NotifyOnAddCorrespondenceToCase field's value. +func (s *CreateSlackChannelConfigurationInput) SetNotifyOnAddCorrespondenceToCase(v bool) *CreateSlackChannelConfigurationInput { + s.NotifyOnAddCorrespondenceToCase = &v + return s +} + +// SetNotifyOnCaseSeverity sets the NotifyOnCaseSeverity field's value. +func (s *CreateSlackChannelConfigurationInput) SetNotifyOnCaseSeverity(v string) *CreateSlackChannelConfigurationInput { + s.NotifyOnCaseSeverity = &v + return s +} + +// SetNotifyOnCreateOrReopenCase sets the NotifyOnCreateOrReopenCase field's value. +func (s *CreateSlackChannelConfigurationInput) SetNotifyOnCreateOrReopenCase(v bool) *CreateSlackChannelConfigurationInput { + s.NotifyOnCreateOrReopenCase = &v + return s +} + +// SetNotifyOnResolveCase sets the NotifyOnResolveCase field's value. +func (s *CreateSlackChannelConfigurationInput) SetNotifyOnResolveCase(v bool) *CreateSlackChannelConfigurationInput { + s.NotifyOnResolveCase = &v + return s +} + +// SetTeamId sets the TeamId field's value. +func (s *CreateSlackChannelConfigurationInput) SetTeamId(v string) *CreateSlackChannelConfigurationInput { + s.TeamId = &v + return s +} + +type CreateSlackChannelConfigurationOutput 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 CreateSlackChannelConfigurationOutput) 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 CreateSlackChannelConfigurationOutput) GoString() string { + return s.String() +} + +type DeleteAccountAliasInput 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 DeleteAccountAliasInput) 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 DeleteAccountAliasInput) GoString() string { + return s.String() +} + +type DeleteAccountAliasOutput 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 DeleteAccountAliasOutput) 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 DeleteAccountAliasOutput) GoString() string { + return s.String() +} + +type DeleteSlackChannelConfigurationInput struct { + _ struct{} `type:"structure"` + + // The channel ID in Slack. This ID identifies a channel within a Slack workspace. + // + // ChannelId is a required field + ChannelId *string `locationName:"channelId" min:"1" type:"string" required:"true"` + + // The team ID in Slack. This ID uniquely identifies a Slack workspace. + // + // TeamId is a required field + TeamId *string `locationName:"teamId" 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 DeleteSlackChannelConfigurationInput) 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 DeleteSlackChannelConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteSlackChannelConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteSlackChannelConfigurationInput"} + if s.ChannelId == nil { + invalidParams.Add(request.NewErrParamRequired("ChannelId")) + } + if s.ChannelId != nil && len(*s.ChannelId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ChannelId", 1)) + } + if s.TeamId == nil { + invalidParams.Add(request.NewErrParamRequired("TeamId")) + } + if s.TeamId != nil && len(*s.TeamId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TeamId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetChannelId sets the ChannelId field's value. +func (s *DeleteSlackChannelConfigurationInput) SetChannelId(v string) *DeleteSlackChannelConfigurationInput { + s.ChannelId = &v + return s +} + +// SetTeamId sets the TeamId field's value. +func (s *DeleteSlackChannelConfigurationInput) SetTeamId(v string) *DeleteSlackChannelConfigurationInput { + s.TeamId = &v + return s +} + +type DeleteSlackChannelConfigurationOutput 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 DeleteSlackChannelConfigurationOutput) 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 DeleteSlackChannelConfigurationOutput) GoString() string { + return s.String() +} + +type DeleteSlackWorkspaceConfigurationInput struct { + _ struct{} `type:"structure"` + + // The team ID in Slack. This ID uniquely identifies a Slack workspace. + // + // TeamId is a required field + TeamId *string `locationName:"teamId" 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 DeleteSlackWorkspaceConfigurationInput) 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 DeleteSlackWorkspaceConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteSlackWorkspaceConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteSlackWorkspaceConfigurationInput"} + if s.TeamId == nil { + invalidParams.Add(request.NewErrParamRequired("TeamId")) + } + if s.TeamId != nil && len(*s.TeamId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TeamId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetTeamId sets the TeamId field's value. +func (s *DeleteSlackWorkspaceConfigurationInput) SetTeamId(v string) *DeleteSlackWorkspaceConfigurationInput { + s.TeamId = &v + return s +} + +type DeleteSlackWorkspaceConfigurationOutput 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 DeleteSlackWorkspaceConfigurationOutput) 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 DeleteSlackWorkspaceConfigurationOutput) GoString() string { + return s.String() +} + +type GetAccountAliasInput 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 GetAccountAliasInput) 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 GetAccountAliasInput) GoString() string { + return s.String() +} + +type GetAccountAliasOutput struct { + _ struct{} `type:"structure"` + + // An alias or short name for an Amazon Web Services account. + AccountAlias *string `locationName:"accountAlias" 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 GetAccountAliasOutput) 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 GetAccountAliasOutput) GoString() string { + return s.String() +} + +// SetAccountAlias sets the AccountAlias field's value. +func (s *GetAccountAliasOutput) SetAccountAlias(v string) *GetAccountAliasOutput { + s.AccountAlias = &v + return s +} + +// We can’t process your request right now because of a server issue. Try +// again later. +type InternalServerException 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 InternalServerException) 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 InternalServerException) GoString() string { + return s.String() +} + +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 +} + +// RequestID returns the service's response RequestID for request. +func (s *InternalServerException) RequestID() string { + return s.RespMetadata.RequestID +} + +type ListSlackChannelConfigurationsInput struct { + _ struct{} `type:"structure"` + + // If the results of a search are large, the API only returns a portion of the + // results and includes a nextToken pagination token in the response. To retrieve + // the next batch of results, reissue the search request and include the returned + // token. When the API returns the last set of results, the response doesn't + // include a pagination token value. + NextToken *string `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 ListSlackChannelConfigurationsInput) 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 ListSlackChannelConfigurationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListSlackChannelConfigurationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListSlackChannelConfigurationsInput"} + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSlackChannelConfigurationsInput) SetNextToken(v string) *ListSlackChannelConfigurationsInput { + s.NextToken = &v + return s +} + +type ListSlackChannelConfigurationsOutput struct { + _ struct{} `type:"structure"` + + // The point where pagination should resume when the response returns only partial + // results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` + + // The configurations for a Slack channel. + // + // SlackChannelConfigurations is a required field + SlackChannelConfigurations []*SlackChannelConfiguration `locationName:"slackChannelConfigurations" 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 ListSlackChannelConfigurationsOutput) 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 ListSlackChannelConfigurationsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSlackChannelConfigurationsOutput) SetNextToken(v string) *ListSlackChannelConfigurationsOutput { + s.NextToken = &v + return s +} + +// SetSlackChannelConfigurations sets the SlackChannelConfigurations field's value. +func (s *ListSlackChannelConfigurationsOutput) SetSlackChannelConfigurations(v []*SlackChannelConfiguration) *ListSlackChannelConfigurationsOutput { + s.SlackChannelConfigurations = v + return s +} + +type ListSlackWorkspaceConfigurationsInput struct { + _ struct{} `type:"structure"` + + // If the results of a search are large, the API only returns a portion of the + // results and includes a nextToken pagination token in the response. To retrieve + // the next batch of results, reissue the search request and include the returned + // token. When the API returns the last set of results, the response doesn't + // include a pagination token value. + NextToken *string `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 ListSlackWorkspaceConfigurationsInput) 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 ListSlackWorkspaceConfigurationsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListSlackWorkspaceConfigurationsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListSlackWorkspaceConfigurationsInput"} + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSlackWorkspaceConfigurationsInput) SetNextToken(v string) *ListSlackWorkspaceConfigurationsInput { + s.NextToken = &v + return s +} + +type ListSlackWorkspaceConfigurationsOutput struct { + _ struct{} `type:"structure"` + + // The point where pagination should resume when the response returns only partial + // results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` + + // The configurations for a Slack workspace. + SlackWorkspaceConfigurations []*SlackWorkspaceConfiguration `locationName:"slackWorkspaceConfigurations" 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 ListSlackWorkspaceConfigurationsOutput) 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 ListSlackWorkspaceConfigurationsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSlackWorkspaceConfigurationsOutput) SetNextToken(v string) *ListSlackWorkspaceConfigurationsOutput { + s.NextToken = &v + return s +} + +// SetSlackWorkspaceConfigurations sets the SlackWorkspaceConfigurations field's value. +func (s *ListSlackWorkspaceConfigurationsOutput) SetSlackWorkspaceConfigurations(v []*SlackWorkspaceConfiguration) *ListSlackWorkspaceConfigurationsOutput { + s.SlackWorkspaceConfigurations = v + return s +} + +type PutAccountAliasInput struct { + _ struct{} `type:"structure"` + + // An alias or short name for an Amazon Web Services account. + // + // AccountAlias is a required field + AccountAlias *string `locationName:"accountAlias" 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 PutAccountAliasInput) 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 PutAccountAliasInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PutAccountAliasInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PutAccountAliasInput"} + if s.AccountAlias == nil { + invalidParams.Add(request.NewErrParamRequired("AccountAlias")) + } + if s.AccountAlias != nil && len(*s.AccountAlias) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AccountAlias", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAccountAlias sets the AccountAlias field's value. +func (s *PutAccountAliasInput) SetAccountAlias(v string) *PutAccountAliasInput { + s.AccountAlias = &v + return s +} + +type PutAccountAliasOutput 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 PutAccountAliasOutput) 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 PutAccountAliasOutput) GoString() string { + return s.String() +} + +// The specified resource is missing or doesn't exist, such as an account alias +// or Slack channel configuration. +type ResourceNotFoundException 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 ResourceNotFoundException) 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 ResourceNotFoundException) GoString() string { + return s.String() +} + +func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error { + return &ResourceNotFoundException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ResourceNotFoundException) Code() string { + return "ResourceNotFoundException" +} + +// Message returns the exception's message. +func (s *ResourceNotFoundException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// 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 +} + +// Your Service Quotas request exceeds the quota for the service. For example, +// your Service Quotas request to Amazon Web Services Support App might exceed +// the maximum number of workspaces or channels per account, or the maximum +// number of accounts per Slack channel. +type ServiceQuotaExceededException 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 ServiceQuotaExceededException) 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 ServiceQuotaExceededException) GoString() string { + return s.String() +} + +func newErrorServiceQuotaExceededException(v protocol.ResponseMetadata) error { + return &ServiceQuotaExceededException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ServiceQuotaExceededException) Code() string { + return "ServiceQuotaExceededException" +} + +// Message returns the exception's message. +func (s *ServiceQuotaExceededException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ServiceQuotaExceededException) OrigErr() error { + return nil +} + +func (s *ServiceQuotaExceededException) 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 *ServiceQuotaExceededException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ServiceQuotaExceededException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The configuration for a Slack channel that you added to an Amazon Web Services +// account. +type SlackChannelConfiguration struct { + _ struct{} `type:"structure"` + + // The channel ID in Slack. This ID identifies a channel within a Slack workspace. + // + // ChannelId is a required field + ChannelId *string `locationName:"channelId" min:"1" type:"string" required:"true"` + + // The name of the Slack channel that you configured with the Amazon Web Services + // Support App. + ChannelName *string `locationName:"channelName" min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of an IAM role that you want to use to perform + // operations on Amazon Web Services. For more information, see Managing access + // to the Amazon Web Services Support App (https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html) + // in the Amazon Web Services Support User Guide. + ChannelRoleArn *string `locationName:"channelRoleArn" min:"31" type:"string"` + + // Whether you want to get notified when a support case has a new correspondence. + NotifyOnAddCorrespondenceToCase *bool `locationName:"notifyOnAddCorrespondenceToCase" type:"boolean"` + + // The case severity for a support case that you want to receive notifications. + NotifyOnCaseSeverity *string `locationName:"notifyOnCaseSeverity" type:"string" enum:"NotificationSeverityLevel"` + + // Whether you want to get notified when a support case is created or reopened. + NotifyOnCreateOrReopenCase *bool `locationName:"notifyOnCreateOrReopenCase" type:"boolean"` + + // Whether you want to get notified when a support case is resolved. + NotifyOnResolveCase *bool `locationName:"notifyOnResolveCase" type:"boolean"` + + // The team ID in Slack. This ID uniquely identifies a Slack workspace. + // + // TeamId is a required field + TeamId *string `locationName:"teamId" 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 SlackChannelConfiguration) 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 SlackChannelConfiguration) GoString() string { + return s.String() +} + +// SetChannelId sets the ChannelId field's value. +func (s *SlackChannelConfiguration) SetChannelId(v string) *SlackChannelConfiguration { + s.ChannelId = &v + return s +} + +// SetChannelName sets the ChannelName field's value. +func (s *SlackChannelConfiguration) SetChannelName(v string) *SlackChannelConfiguration { + s.ChannelName = &v + return s +} + +// SetChannelRoleArn sets the ChannelRoleArn field's value. +func (s *SlackChannelConfiguration) SetChannelRoleArn(v string) *SlackChannelConfiguration { + s.ChannelRoleArn = &v + return s +} + +// SetNotifyOnAddCorrespondenceToCase sets the NotifyOnAddCorrespondenceToCase field's value. +func (s *SlackChannelConfiguration) SetNotifyOnAddCorrespondenceToCase(v bool) *SlackChannelConfiguration { + s.NotifyOnAddCorrespondenceToCase = &v + return s +} + +// SetNotifyOnCaseSeverity sets the NotifyOnCaseSeverity field's value. +func (s *SlackChannelConfiguration) SetNotifyOnCaseSeverity(v string) *SlackChannelConfiguration { + s.NotifyOnCaseSeverity = &v + return s +} + +// SetNotifyOnCreateOrReopenCase sets the NotifyOnCreateOrReopenCase field's value. +func (s *SlackChannelConfiguration) SetNotifyOnCreateOrReopenCase(v bool) *SlackChannelConfiguration { + s.NotifyOnCreateOrReopenCase = &v + return s +} + +// SetNotifyOnResolveCase sets the NotifyOnResolveCase field's value. +func (s *SlackChannelConfiguration) SetNotifyOnResolveCase(v bool) *SlackChannelConfiguration { + s.NotifyOnResolveCase = &v + return s +} + +// SetTeamId sets the TeamId field's value. +func (s *SlackChannelConfiguration) SetTeamId(v string) *SlackChannelConfiguration { + s.TeamId = &v + return s +} + +// The configuration for a Slack workspace that you added to an Amazon Web Services +// account. +type SlackWorkspaceConfiguration struct { + _ struct{} `type:"structure"` + + // The team ID in Slack. This ID uniquely identifies a Slack workspace. + // + // TeamId is a required field + TeamId *string `locationName:"teamId" 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 SlackWorkspaceConfiguration) 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 SlackWorkspaceConfiguration) GoString() string { + return s.String() +} + +// SetTeamId sets the TeamId field's value. +func (s *SlackWorkspaceConfiguration) SetTeamId(v string) *SlackWorkspaceConfiguration { + s.TeamId = &v + return s +} + +type UpdateSlackChannelConfigurationInput struct { + _ struct{} `type:"structure"` + + // The channel ID in Slack. This ID identifies a channel within a Slack workspace. + // + // ChannelId is a required field + ChannelId *string `locationName:"channelId" min:"1" type:"string" required:"true"` + + // The Slack channel name that you want to update. + ChannelName *string `locationName:"channelName" min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of an IAM role that you want to use to perform + // operations on Amazon Web Services. For more information, see Managing access + // to the Amazon Web Services Support App (https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html) + // in the Amazon Web Services Support User Guide. + ChannelRoleArn *string `locationName:"channelRoleArn" min:"31" type:"string"` + + // Whether you want to get notified when a support case has a new correspondence. + NotifyOnAddCorrespondenceToCase *bool `locationName:"notifyOnAddCorrespondenceToCase" type:"boolean"` + + // The case severity for a support case that you want to receive notifications. + // + //

If you specify high or all, at least one + // of the following parameters must be true:

  • + // notifyOnAddCorrespondenceToCase

  • notifyOnCreateOrReopenCase + //

  • notifyOnResolveCase

+ //

If you specify none, any of the following parameters that + // you specify in your request must be false:

  • + //

    notifyOnAddCorrespondenceToCase

  • notifyOnCreateOrReopenCase + //

  • notifyOnResolveCase

+ //

If you don't specify these parameters in your request, the Amazon + // Web Services Support App uses the current values by default.

 + NotifyOnCaseSeverity *string `locationName:"notifyOnCaseSeverity" type:"string" enum:"NotificationSeverityLevel"` + + // Whether you want to get notified when a support case is created or reopened. + NotifyOnCreateOrReopenCase *bool `locationName:"notifyOnCreateOrReopenCase" type:"boolean"` + + // Whether you want to get notified when a support case is resolved. + NotifyOnResolveCase *bool `locationName:"notifyOnResolveCase" type:"boolean"` + + // The team ID in Slack. This ID uniquely identifies a Slack workspace. + // + // TeamId is a required field + TeamId *string `locationName:"teamId" 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 UpdateSlackChannelConfigurationInput) 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 UpdateSlackChannelConfigurationInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateSlackChannelConfigurationInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateSlackChannelConfigurationInput"} + if s.ChannelId == nil { + invalidParams.Add(request.NewErrParamRequired("ChannelId")) + } + if s.ChannelId != nil && len(*s.ChannelId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ChannelId", 1)) + } + if s.ChannelName != nil && len(*s.ChannelName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ChannelName", 1)) + } + if s.ChannelRoleArn != nil && len(*s.ChannelRoleArn) < 31 { + invalidParams.Add(request.NewErrParamMinLen("ChannelRoleArn", 31)) + } + if s.TeamId == nil { + invalidParams.Add(request.NewErrParamRequired("TeamId")) + } + if s.TeamId != nil && len(*s.TeamId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TeamId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetChannelId sets the ChannelId field's value. +func (s *UpdateSlackChannelConfigurationInput) SetChannelId(v string) *UpdateSlackChannelConfigurationInput { + s.ChannelId = &v + return s +} + +// SetChannelName sets the ChannelName field's value. +func (s *UpdateSlackChannelConfigurationInput) SetChannelName(v string) *UpdateSlackChannelConfigurationInput { + s.ChannelName = &v + return s +} + +// SetChannelRoleArn sets the ChannelRoleArn field's value. +func (s *UpdateSlackChannelConfigurationInput) SetChannelRoleArn(v string) *UpdateSlackChannelConfigurationInput { + s.ChannelRoleArn = &v + return s +} + +// SetNotifyOnAddCorrespondenceToCase sets the NotifyOnAddCorrespondenceToCase field's value. +func (s *UpdateSlackChannelConfigurationInput) SetNotifyOnAddCorrespondenceToCase(v bool) *UpdateSlackChannelConfigurationInput { + s.NotifyOnAddCorrespondenceToCase = &v + return s +} + +// SetNotifyOnCaseSeverity sets the NotifyOnCaseSeverity field's value. +func (s *UpdateSlackChannelConfigurationInput) SetNotifyOnCaseSeverity(v string) *UpdateSlackChannelConfigurationInput { + s.NotifyOnCaseSeverity = &v + return s +} + +// SetNotifyOnCreateOrReopenCase sets the NotifyOnCreateOrReopenCase field's value. +func (s *UpdateSlackChannelConfigurationInput) SetNotifyOnCreateOrReopenCase(v bool) *UpdateSlackChannelConfigurationInput { + s.NotifyOnCreateOrReopenCase = &v + return s +} + +// SetNotifyOnResolveCase sets the NotifyOnResolveCase field's value. +func (s *UpdateSlackChannelConfigurationInput) SetNotifyOnResolveCase(v bool) *UpdateSlackChannelConfigurationInput { + s.NotifyOnResolveCase = &v + return s +} + +// SetTeamId sets the TeamId field's value. +func (s *UpdateSlackChannelConfigurationInput) SetTeamId(v string) *UpdateSlackChannelConfigurationInput { + s.TeamId = &v + return s +} + +type UpdateSlackChannelConfigurationOutput struct { + _ struct{} `type:"structure"` + + // The channel ID in Slack. This ID identifies a channel within a Slack workspace. + ChannelId *string `locationName:"channelId" min:"1" type:"string"` + + // The name of the Slack channel that you configure for the Amazon Web Services + // Support App. + ChannelName *string `locationName:"channelName" min:"1" type:"string"` + + // The Amazon Resource Name (ARN) of an IAM role that you want to use to perform + // operations on Amazon Web Services. For more information, see Managing access + // to the Amazon Web Services Support App (https://docs.aws.amazon.com/awssupport/latest/user/support-app-permissions.html) + // in the Amazon Web Services Support User Guide. + ChannelRoleArn *string `locationName:"channelRoleArn" min:"31" type:"string"` + + // Whether you want to get notified when a support case has a new correspondence. + NotifyOnAddCorrespondenceToCase *bool `locationName:"notifyOnAddCorrespondenceToCase" type:"boolean"` + + // The case severity for a support case that you want to receive notifications. + NotifyOnCaseSeverity *string `locationName:"notifyOnCaseSeverity" type:"string" enum:"NotificationSeverityLevel"` + + // Whether you want to get notified when a support case is created or reopened. + NotifyOnCreateOrReopenCase *bool `locationName:"notifyOnCreateOrReopenCase" type:"boolean"` + + // Whether you want to get notified when a support case is resolved. + NotifyOnResolveCase *bool `locationName:"notifyOnResolveCase" type:"boolean"` + + // The team ID in Slack. This ID uniquely identifies a Slack workspace. + TeamId *string `locationName:"teamId" 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 UpdateSlackChannelConfigurationOutput) 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 UpdateSlackChannelConfigurationOutput) GoString() string { + return s.String() +} + +// SetChannelId sets the ChannelId field's value. +func (s *UpdateSlackChannelConfigurationOutput) SetChannelId(v string) *UpdateSlackChannelConfigurationOutput { + s.ChannelId = &v + return s +} + +// SetChannelName sets the ChannelName field's value. +func (s *UpdateSlackChannelConfigurationOutput) SetChannelName(v string) *UpdateSlackChannelConfigurationOutput { + s.ChannelName = &v + return s +} + +// SetChannelRoleArn sets the ChannelRoleArn field's value. +func (s *UpdateSlackChannelConfigurationOutput) SetChannelRoleArn(v string) *UpdateSlackChannelConfigurationOutput { + s.ChannelRoleArn = &v + return s +} + +// SetNotifyOnAddCorrespondenceToCase sets the NotifyOnAddCorrespondenceToCase field's value. +func (s *UpdateSlackChannelConfigurationOutput) SetNotifyOnAddCorrespondenceToCase(v bool) *UpdateSlackChannelConfigurationOutput { + s.NotifyOnAddCorrespondenceToCase = &v + return s +} + +// SetNotifyOnCaseSeverity sets the NotifyOnCaseSeverity field's value. +func (s *UpdateSlackChannelConfigurationOutput) SetNotifyOnCaseSeverity(v string) *UpdateSlackChannelConfigurationOutput { + s.NotifyOnCaseSeverity = &v + return s +} + +// SetNotifyOnCreateOrReopenCase sets the NotifyOnCreateOrReopenCase field's value. +func (s *UpdateSlackChannelConfigurationOutput) SetNotifyOnCreateOrReopenCase(v bool) *UpdateSlackChannelConfigurationOutput { + s.NotifyOnCreateOrReopenCase = &v + return s +} + +// SetNotifyOnResolveCase sets the NotifyOnResolveCase field's value. +func (s *UpdateSlackChannelConfigurationOutput) SetNotifyOnResolveCase(v bool) *UpdateSlackChannelConfigurationOutput { + s.NotifyOnResolveCase = &v + return s +} + +// SetTeamId sets the TeamId field's value. +func (s *UpdateSlackChannelConfigurationOutput) SetTeamId(v string) *UpdateSlackChannelConfigurationOutput { + s.TeamId = &v + return s +} + +// Your request input doesn't meet the constraints that the Amazon Web Services +// Support App specifies. +type ValidationException 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 ValidationException) 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 ValidationException) GoString() string { + return s.String() +} + +func newErrorValidationException(v protocol.ResponseMetadata) error { + return &ValidationException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ValidationException) Code() string { + return "ValidationException" +} + +// Message returns the exception's message. +func (s *ValidationException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ValidationException) OrigErr() error { + return nil +} + +func (s *ValidationException) 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 *ValidationException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ValidationException) RequestID() string { + return s.RespMetadata.RequestID +} + +const ( + // NotificationSeverityLevelNone is a NotificationSeverityLevel enum value + NotificationSeverityLevelNone = "none" + + // NotificationSeverityLevelAll is a NotificationSeverityLevel enum value + NotificationSeverityLevelAll = "all" + + // NotificationSeverityLevelHigh is a NotificationSeverityLevel enum value + NotificationSeverityLevelHigh = "high" +) + +// NotificationSeverityLevel_Values returns all elements of the NotificationSeverityLevel enum +func NotificationSeverityLevel_Values() []string { + return []string{ + NotificationSeverityLevelNone, + NotificationSeverityLevelAll, + NotificationSeverityLevelHigh, + } +} diff --git a/service/supportapp/doc.go b/service/supportapp/doc.go new file mode 100644 index 0000000000..eb2c635144 --- /dev/null +++ b/service/supportapp/doc.go @@ -0,0 +1,61 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package supportapp provides the client and types for making API +// requests to AWS Support App. +// +// You can use the Amazon Web Services Support App in Slack API to manage your +// support cases in Slack for your Amazon Web Services account. After you configure +// your Slack workspace and channel with the Amazon Web Services Support App, +// you can perform the following tasks directly in your Slack channel: +// +// - Create, search, update, and resolve your support cases +// +// - Request service quota increases for your account +// +// - Invite Amazon Web Services Support agents to your channel so that you +// can chat directly about your support cases +// +// For more information about how to perform these actions in Slack, see the +// following documentation in the Amazon Web Services Support User Guide: +// +// - Amazon Web Services Support App in Slack (https://docs.aws.amazon.com/awssupport/latest/user/aws-support-app-for-slack.html) +// +// - Joining a live chat session with Amazon Web Services Support (https://docs.aws.amazon.com/awssupport/latest/user/joining-a-live-chat-session.html) +// +// - Requesting service quota increases (https://docs.aws.amazon.com/awssupport/latest/user/service-quota-increase.html) +// +// - Amazon Web Services Support App commands in Slack (https://docs.aws.amazon.com/awssupport/latest/user/support-app-commands.html) +// +// You can also use the Amazon Web Services Management Console instead of the +// Amazon Web Services Support App API to manage your Slack configurations. +// For more information, see Authorize a Slack workspace to enable the Amazon +// Web Services Support App (https://docs.aws.amazon.com/awssupport/latest/user/authorize-slack-workspace.html). +// +//

  • You must have a Business or Enterprise Support plan +// to use the Amazon Web Services Support App API.

  • For +// more information about the Amazon Web Services Support App endpoints, +// see the Amazon +// Web Services Support App in Slack endpoints in the Amazon Web Services +// General Reference.

 +// +// See https://docs.aws.amazon.com/goto/WebAPI/support-app-2021-08-20 for more information on this service. +// +// See supportapp package documentation for more information. +// https://docs.aws.amazon.com/sdk-for-go/api/service/supportapp/ +// +// # Using the Client +// +// To contact AWS Support App with the SDK use the New function to create +// a new service client. With that client you can make API requests to the service. +// These clients are safe to use concurrently. +// +// See the SDK's documentation for more information on how to use the SDK. +// https://docs.aws.amazon.com/sdk-for-go/api/ +// +// See aws.Config documentation for more information on configuring SDK clients. +// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config +// +// See the AWS Support App client SupportApp for more +// information on creating client for this service. +// https://docs.aws.amazon.com/sdk-for-go/api/service/supportapp/#New +package supportapp diff --git a/service/supportapp/errors.go b/service/supportapp/errors.go new file mode 100644 index 0000000000..fa3964a9de --- /dev/null +++ b/service/supportapp/errors.go @@ -0,0 +1,73 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package supportapp + +import ( + "github.com/aws/aws-sdk-go/private/protocol" +) + +const ( + + // ErrCodeAccessDeniedException for service response error code + // "AccessDeniedException". + // + // You don't have sufficient permission to perform this action. + ErrCodeAccessDeniedException = "AccessDeniedException" + + // ErrCodeConflictException for service response error code + // "ConflictException". + // + // Your request has a conflict. For example, you might receive this error if + // you try the following: + // + // * Add, update, or delete a Slack channel configuration before you add + // a Slack workspace to your Amazon Web Services account. + // + // * Add a Slack channel configuration that already exists in your Amazon + // Web Services account. + // + // * Delete a Slack channel configuration for a live chat channel. + // + // * Delete a Slack workspace from your Amazon Web Services account that + // has an active live chat channel. + ErrCodeConflictException = "ConflictException" + + // ErrCodeInternalServerException for service response error code + // "InternalServerException". + // + // We can’t process your request right now because of a server issue. Try + // again later. + ErrCodeInternalServerException = "InternalServerException" + + // ErrCodeResourceNotFoundException for service response error code + // "ResourceNotFoundException". + // + // The specified resource is missing or doesn't exist, such as an account alias + // or Slack channel configuration. + ErrCodeResourceNotFoundException = "ResourceNotFoundException" + + // ErrCodeServiceQuotaExceededException for service response error code + // "ServiceQuotaExceededException". + // + // Your Service Quotas request exceeds the quota for the service. For example, + // your Service Quotas request to Amazon Web Services Support App might exceed + // the maximum number of workspaces or channels per account, or the maximum + // number of accounts per Slack channel. + ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" + + // ErrCodeValidationException for service response error code + // "ValidationException". + // + // Your request input doesn't meet the constraints that the Amazon Web Services + // Support App specifies. + ErrCodeValidationException = "ValidationException" +) + +var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ + "AccessDeniedException": newErrorAccessDeniedException, + "ConflictException": newErrorConflictException, + "InternalServerException": newErrorInternalServerException, + "ResourceNotFoundException": newErrorResourceNotFoundException, + "ServiceQuotaExceededException": newErrorServiceQuotaExceededException, + "ValidationException": newErrorValidationException, +} diff --git a/service/supportapp/service.go b/service/supportapp/service.go new file mode 100644 index 0000000000..0c3a792e97 --- /dev/null +++ b/service/supportapp/service.go @@ -0,0 +1,106 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package supportapp + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/client" + "github.com/aws/aws-sdk-go/aws/client/metadata" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/aws/signer/v4" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +// SupportApp provides the API operation methods for making requests to +// AWS Support App. See this package's package overview docs +// for details on the service. +// +// SupportApp methods are safe to use concurrently. It is not safe to +// modify mutate any of the struct's properties though. +type SupportApp struct { + *client.Client +} + +// Used for custom client initialization logic +var initClient func(*client.Client) + +// Used for custom request initialization logic +var initRequest func(*request.Request) + +// Service information constants +const ( + ServiceName = "Support App" // Name of service. + EndpointsID = "supportapp" // ID to lookup a service endpoint with. + ServiceID = "Support App" // ServiceID is a unique identifier of a specific service. +) + +// New creates a new instance of the SupportApp client with a session. +// If additional configuration is needed for the client instance use the optional +// aws.Config parameter to add your extra config. +// +// Example: +// +// mySession := session.Must(session.NewSession()) +// +// // Create a SupportApp client from just a session. +// svc := supportapp.New(mySession) +// +// // Create a SupportApp client with additional configuration +// svc := supportapp.New(mySession, aws.NewConfig().WithRegion("us-west-2")) +func New(p client.ConfigProvider, cfgs ...*aws.Config) *SupportApp { + c := p.ClientConfig(EndpointsID, cfgs...) + if c.SigningNameDerived || len(c.SigningName) == 0 { + c.SigningName = "supportapp" + } + return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName, c.ResolvedRegion) +} + +// newClient creates, initializes and returns a new service client instance. +func newClient(cfg aws.Config, handlers request.Handlers, partitionID, endpoint, signingRegion, signingName, resolvedRegion string) *SupportApp { + svc := &SupportApp{ + Client: client.New( + cfg, + metadata.ClientInfo{ + ServiceName: ServiceName, + ServiceID: ServiceID, + SigningName: signingName, + SigningRegion: signingRegion, + PartitionID: partitionID, + Endpoint: endpoint, + APIVersion: "2021-08-20", + ResolvedRegion: resolvedRegion, + }, + handlers, + ), + } + + // Handlers + svc.Handlers.Sign.PushBackNamed(v4.SignRequestHandler) + svc.Handlers.Build.PushBackNamed(restjson.BuildHandler) + svc.Handlers.Unmarshal.PushBackNamed(restjson.UnmarshalHandler) + svc.Handlers.UnmarshalMeta.PushBackNamed(restjson.UnmarshalMetaHandler) + svc.Handlers.UnmarshalError.PushBackNamed( + protocol.NewUnmarshalErrorHandler(restjson.NewUnmarshalTypedError(exceptionFromCode)).NamedHandler(), + ) + + // Run custom client initialization if present + if initClient != nil { + initClient(svc.Client) + } + + return svc +} + +// newRequest creates a new request for a SupportApp operation and runs any +// custom request initialization. +func (c *SupportApp) newRequest(op *request.Operation, params, data interface{}) *request.Request { + req := c.NewRequest(op, params, data) + + // Run custom request initialization if present + if initRequest != nil { + initRequest(req) + } + + return req +} diff --git a/service/supportapp/supportappiface/interface.go b/service/supportapp/supportappiface/interface.go new file mode 100644 index 0000000000..fb9d71b642 --- /dev/null +++ b/service/supportapp/supportappiface/interface.go @@ -0,0 +1,106 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package supportappiface provides an interface to enable mocking the AWS Support App service client +// for testing your code. +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. +package supportappiface + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/service/supportapp" +) + +// SupportAppAPI provides an interface to enable mocking the +// supportapp.SupportApp service client's API operation, +// paginators, and waiters. This make unit testing your code that calls out +// to the SDK's service client's calls easier. +// +// The best way to use this interface is so the SDK's service client's calls +// can be stubbed out for unit testing your code with the SDK without needing +// to inject custom request handlers into the SDK's request pipeline. +// +// // myFunc uses an SDK service client to make a request to +// // AWS Support App. +// func myFunc(svc supportappiface.SupportAppAPI) bool { +// // Make svc.CreateSlackChannelConfiguration request +// } +// +// func main() { +// sess := session.New() +// svc := supportapp.New(sess) +// +// myFunc(svc) +// } +// +// In your _test.go file: +// +// // Define a mock struct to be used in your unit tests of myFunc. +// type mockSupportAppClient struct { +// supportappiface.SupportAppAPI +// } +// func (m *mockSupportAppClient) CreateSlackChannelConfiguration(input *supportapp.CreateSlackChannelConfigurationInput) (*supportapp.CreateSlackChannelConfigurationOutput, error) { +// // mock response/functionality +// } +// +// func TestMyFunc(t *testing.T) { +// // Setup Test +// mockSvc := &mockSupportAppClient{} +// +// myfunc(mockSvc) +// +// // Verify myFunc's functionality +// } +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. Its suggested to use the pattern above for testing, or using +// tooling to generate mocks to satisfy the interfaces. +type SupportAppAPI interface { + CreateSlackChannelConfiguration(*supportapp.CreateSlackChannelConfigurationInput) (*supportapp.CreateSlackChannelConfigurationOutput, error) + CreateSlackChannelConfigurationWithContext(aws.Context, *supportapp.CreateSlackChannelConfigurationInput, ...request.Option) (*supportapp.CreateSlackChannelConfigurationOutput, error) + CreateSlackChannelConfigurationRequest(*supportapp.CreateSlackChannelConfigurationInput) (*request.Request, *supportapp.CreateSlackChannelConfigurationOutput) + + DeleteAccountAlias(*supportapp.DeleteAccountAliasInput) (*supportapp.DeleteAccountAliasOutput, error) + DeleteAccountAliasWithContext(aws.Context, *supportapp.DeleteAccountAliasInput, ...request.Option) (*supportapp.DeleteAccountAliasOutput, error) + DeleteAccountAliasRequest(*supportapp.DeleteAccountAliasInput) (*request.Request, *supportapp.DeleteAccountAliasOutput) + + DeleteSlackChannelConfiguration(*supportapp.DeleteSlackChannelConfigurationInput) (*supportapp.DeleteSlackChannelConfigurationOutput, error) + DeleteSlackChannelConfigurationWithContext(aws.Context, *supportapp.DeleteSlackChannelConfigurationInput, ...request.Option) (*supportapp.DeleteSlackChannelConfigurationOutput, error) + DeleteSlackChannelConfigurationRequest(*supportapp.DeleteSlackChannelConfigurationInput) (*request.Request, *supportapp.DeleteSlackChannelConfigurationOutput) + + DeleteSlackWorkspaceConfiguration(*supportapp.DeleteSlackWorkspaceConfigurationInput) (*supportapp.DeleteSlackWorkspaceConfigurationOutput, error) + DeleteSlackWorkspaceConfigurationWithContext(aws.Context, *supportapp.DeleteSlackWorkspaceConfigurationInput, ...request.Option) (*supportapp.DeleteSlackWorkspaceConfigurationOutput, error) + DeleteSlackWorkspaceConfigurationRequest(*supportapp.DeleteSlackWorkspaceConfigurationInput) (*request.Request, *supportapp.DeleteSlackWorkspaceConfigurationOutput) + + GetAccountAlias(*supportapp.GetAccountAliasInput) (*supportapp.GetAccountAliasOutput, error) + GetAccountAliasWithContext(aws.Context, *supportapp.GetAccountAliasInput, ...request.Option) (*supportapp.GetAccountAliasOutput, error) + GetAccountAliasRequest(*supportapp.GetAccountAliasInput) (*request.Request, *supportapp.GetAccountAliasOutput) + + ListSlackChannelConfigurations(*supportapp.ListSlackChannelConfigurationsInput) (*supportapp.ListSlackChannelConfigurationsOutput, error) + ListSlackChannelConfigurationsWithContext(aws.Context, *supportapp.ListSlackChannelConfigurationsInput, ...request.Option) (*supportapp.ListSlackChannelConfigurationsOutput, error) + ListSlackChannelConfigurationsRequest(*supportapp.ListSlackChannelConfigurationsInput) (*request.Request, *supportapp.ListSlackChannelConfigurationsOutput) + + ListSlackChannelConfigurationsPages(*supportapp.ListSlackChannelConfigurationsInput, func(*supportapp.ListSlackChannelConfigurationsOutput, bool) bool) error + ListSlackChannelConfigurationsPagesWithContext(aws.Context, *supportapp.ListSlackChannelConfigurationsInput, func(*supportapp.ListSlackChannelConfigurationsOutput, bool) bool, ...request.Option) error + + ListSlackWorkspaceConfigurations(*supportapp.ListSlackWorkspaceConfigurationsInput) (*supportapp.ListSlackWorkspaceConfigurationsOutput, error) + ListSlackWorkspaceConfigurationsWithContext(aws.Context, *supportapp.ListSlackWorkspaceConfigurationsInput, ...request.Option) (*supportapp.ListSlackWorkspaceConfigurationsOutput, error) + ListSlackWorkspaceConfigurationsRequest(*supportapp.ListSlackWorkspaceConfigurationsInput) (*request.Request, *supportapp.ListSlackWorkspaceConfigurationsOutput) + + ListSlackWorkspaceConfigurationsPages(*supportapp.ListSlackWorkspaceConfigurationsInput, func(*supportapp.ListSlackWorkspaceConfigurationsOutput, bool) bool) error + ListSlackWorkspaceConfigurationsPagesWithContext(aws.Context, *supportapp.ListSlackWorkspaceConfigurationsInput, func(*supportapp.ListSlackWorkspaceConfigurationsOutput, bool) bool, ...request.Option) error + + PutAccountAlias(*supportapp.PutAccountAliasInput) (*supportapp.PutAccountAliasOutput, error) + PutAccountAliasWithContext(aws.Context, *supportapp.PutAccountAliasInput, ...request.Option) (*supportapp.PutAccountAliasOutput, error) + PutAccountAliasRequest(*supportapp.PutAccountAliasInput) (*request.Request, *supportapp.PutAccountAliasOutput) + + UpdateSlackChannelConfiguration(*supportapp.UpdateSlackChannelConfigurationInput) (*supportapp.UpdateSlackChannelConfigurationOutput, error) + UpdateSlackChannelConfigurationWithContext(aws.Context, *supportapp.UpdateSlackChannelConfigurationInput, ...request.Option) (*supportapp.UpdateSlackChannelConfigurationOutput, error) + UpdateSlackChannelConfigurationRequest(*supportapp.UpdateSlackChannelConfigurationInput) (*request.Request, *supportapp.UpdateSlackChannelConfigurationOutput) +} + +var _ SupportAppAPI = (*supportapp.SupportApp)(nil)